mirror of
https://github.com/restic/restic.git
synced 2024-09-12 05:58:36 +02:00
739 lines
23 KiB
Go
739 lines
23 KiB
Go
// Package urlshortener provides access to the URL Shortener API.
|
|
//
|
|
// See https://developers.google.com/url-shortener/v1/getting_started
|
|
//
|
|
// Usage example:
|
|
//
|
|
// import "google.golang.org/api/urlshortener/v1"
|
|
// ...
|
|
// urlshortenerService, err := urlshortener.New(oauthHttpClient)
|
|
package urlshortener // import "google.golang.org/api/urlshortener/v1"
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
context "golang.org/x/net/context"
|
|
ctxhttp "golang.org/x/net/context/ctxhttp"
|
|
gensupport "google.golang.org/api/gensupport"
|
|
googleapi "google.golang.org/api/googleapi"
|
|
"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 _ = gensupport.MarshalJSON
|
|
var _ = googleapi.Version
|
|
var _ = errors.New
|
|
var _ = strings.Replace
|
|
var _ = context.Canceled
|
|
var _ = ctxhttp.Do
|
|
|
|
const apiId = "urlshortener:v1"
|
|
const apiName = "urlshortener"
|
|
const apiVersion = "v1"
|
|
const basePath = "https://www.googleapis.com/urlshortener/v1/"
|
|
|
|
// OAuth2 scopes used by this API.
|
|
const (
|
|
// Manage your goo.gl short URLs
|
|
UrlshortenerScope = "https://www.googleapis.com/auth/urlshortener"
|
|
)
|
|
|
|
func New(client *http.Client) (*Service, error) {
|
|
if client == nil {
|
|
return nil, errors.New("client is nil")
|
|
}
|
|
s := &Service{client: client, BasePath: basePath}
|
|
s.Url = NewUrlService(s)
|
|
return s, nil
|
|
}
|
|
|
|
type Service struct {
|
|
client *http.Client
|
|
BasePath string // API endpoint base URL
|
|
UserAgent string // optional additional User-Agent fragment
|
|
|
|
Url *UrlService
|
|
}
|
|
|
|
func (s *Service) userAgent() string {
|
|
if s.UserAgent == "" {
|
|
return googleapi.UserAgent
|
|
}
|
|
return googleapi.UserAgent + " " + s.UserAgent
|
|
}
|
|
|
|
func NewUrlService(s *Service) *UrlService {
|
|
rs := &UrlService{s: s}
|
|
return rs
|
|
}
|
|
|
|
type UrlService struct {
|
|
s *Service
|
|
}
|
|
|
|
type AnalyticsSnapshot struct {
|
|
// Browsers: Top browsers, e.g. "Chrome"; sorted by (descending) click
|
|
// counts. Only present if this data is available.
|
|
Browsers []*StringCount `json:"browsers,omitempty"`
|
|
|
|
// Countries: Top countries (expressed as country codes), e.g. "US" or
|
|
// "DE"; sorted by (descending) click counts. Only present if this data
|
|
// is available.
|
|
Countries []*StringCount `json:"countries,omitempty"`
|
|
|
|
// LongUrlClicks: Number of clicks on all goo.gl short URLs pointing to
|
|
// this long URL.
|
|
LongUrlClicks int64 `json:"longUrlClicks,omitempty,string"`
|
|
|
|
// Platforms: Top platforms or OSes, e.g. "Windows"; sorted by
|
|
// (descending) click counts. Only present if this data is available.
|
|
Platforms []*StringCount `json:"platforms,omitempty"`
|
|
|
|
// Referrers: Top referring hosts, e.g. "www.google.com"; sorted by
|
|
// (descending) click counts. Only present if this data is available.
|
|
Referrers []*StringCount `json:"referrers,omitempty"`
|
|
|
|
// ShortUrlClicks: Number of clicks on this short URL.
|
|
ShortUrlClicks int64 `json:"shortUrlClicks,omitempty,string"`
|
|
|
|
// 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:"-"`
|
|
|
|
// NullFields is a list of field names (e.g. "Browsers") to include in
|
|
// API requests with the JSON null value. By default, fields with empty
|
|
// values are omitted from API requests. However, any field with an
|
|
// empty value appearing in NullFields will be sent to the server as
|
|
// null. It is an error if a field in this list has a non-empty value.
|
|
// This may be used to include null fields in Patch requests.
|
|
NullFields []string `json:"-"`
|
|
}
|
|
|
|
func (s *AnalyticsSnapshot) MarshalJSON() ([]byte, error) {
|
|
type noMethod AnalyticsSnapshot
|
|
raw := noMethod(*s)
|
|
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
|
|
}
|
|
|
|
type AnalyticsSummary struct {
|
|
// AllTime: Click analytics over all time.
|
|
AllTime *AnalyticsSnapshot `json:"allTime,omitempty"`
|
|
|
|
// Day: Click analytics over the last day.
|
|
Day *AnalyticsSnapshot `json:"day,omitempty"`
|
|
|
|
// Month: Click analytics over the last month.
|
|
Month *AnalyticsSnapshot `json:"month,omitempty"`
|
|
|
|
// TwoHours: Click analytics over the last two hours.
|
|
TwoHours *AnalyticsSnapshot `json:"twoHours,omitempty"`
|
|
|
|
// Week: Click analytics over the last week.
|
|
Week *AnalyticsSnapshot `json:"week,omitempty"`
|
|
|
|
// ForceSendFields is a list of field names (e.g. "AllTime") to
|
|
// unconditionally include in API requests. By default, fields with
|
|
// empty values are omitted from API requests. However, any non-pointer,
|
|
// non-interface field appearing in ForceSendFields will be sent to the
|
|
// server regardless of whether the field is empty or not. This may be
|
|
// used to include empty fields in Patch requests.
|
|
ForceSendFields []string `json:"-"`
|
|
|
|
// NullFields is a list of field names (e.g. "AllTime") to include in
|
|
// API requests with the JSON null value. By default, fields with empty
|
|
// values are omitted from API requests. However, any field with an
|
|
// empty value appearing in NullFields will be sent to the server as
|
|
// null. It is an error if a field in this list has a non-empty value.
|
|
// This may be used to include null fields in Patch requests.
|
|
NullFields []string `json:"-"`
|
|
}
|
|
|
|
func (s *AnalyticsSummary) MarshalJSON() ([]byte, error) {
|
|
type noMethod AnalyticsSummary
|
|
raw := noMethod(*s)
|
|
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
|
|
}
|
|
|
|
type StringCount struct {
|
|
// Count: Number of clicks for this top entry, e.g. for this particular
|
|
// country or browser.
|
|
Count int64 `json:"count,omitempty,string"`
|
|
|
|
// Id: Label assigned to this top entry, e.g. "US" or "Chrome".
|
|
Id string `json:"id,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:"-"`
|
|
|
|
// NullFields is a list of field names (e.g. "Count") to include in API
|
|
// requests with the JSON null value. By default, fields with empty
|
|
// values are omitted from API requests. However, any field with an
|
|
// empty value appearing in NullFields will be sent to the server as
|
|
// null. It is an error if a field in this list has a non-empty value.
|
|
// This may be used to include null fields in Patch requests.
|
|
NullFields []string `json:"-"`
|
|
}
|
|
|
|
func (s *StringCount) MarshalJSON() ([]byte, error) {
|
|
type noMethod StringCount
|
|
raw := noMethod(*s)
|
|
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
|
|
}
|
|
|
|
type Url struct {
|
|
// Analytics: A summary of the click analytics for the short and long
|
|
// URL. Might not be present if not requested or currently unavailable.
|
|
Analytics *AnalyticsSummary `json:"analytics,omitempty"`
|
|
|
|
// Created: Time the short URL was created; ISO 8601 representation
|
|
// using the yyyy-MM-dd'T'HH:mm:ss.SSSZZ format, e.g.
|
|
// "2010-10-14T19:01:24.944+00:00".
|
|
Created string `json:"created,omitempty"`
|
|
|
|
// Id: Short URL, e.g. "http://goo.gl/l6MS".
|
|
Id string `json:"id,omitempty"`
|
|
|
|
// Kind: The fixed string "urlshortener#url".
|
|
Kind string `json:"kind,omitempty"`
|
|
|
|
// LongUrl: Long URL, e.g. "http://www.google.com/". Might not be
|
|
// present if the status is "REMOVED".
|
|
LongUrl string `json:"longUrl,omitempty"`
|
|
|
|
// Status: Status of the target URL. Possible values: "OK", "MALWARE",
|
|
// "PHISHING", or "REMOVED". A URL might be marked "REMOVED" if it was
|
|
// flagged as spam, for example.
|
|
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. "Analytics") to
|
|
// unconditionally include in API requests. By default, fields with
|
|
// empty values are omitted from API requests. However, any non-pointer,
|
|
// non-interface field appearing in ForceSendFields will be sent to the
|
|
// server regardless of whether the field is empty or not. This may be
|
|
// used to include empty fields in Patch requests.
|
|
ForceSendFields []string `json:"-"`
|
|
|
|
// NullFields is a list of field names (e.g. "Analytics") to include in
|
|
// API requests with the JSON null value. By default, fields with empty
|
|
// values are omitted from API requests. However, any field with an
|
|
// empty value appearing in NullFields will be sent to the server as
|
|
// null. It is an error if a field in this list has a non-empty value.
|
|
// This may be used to include null fields in Patch requests.
|
|
NullFields []string `json:"-"`
|
|
}
|
|
|
|
func (s *Url) MarshalJSON() ([]byte, error) {
|
|
type noMethod Url
|
|
raw := noMethod(*s)
|
|
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
|
|
}
|
|
|
|
type UrlHistory struct {
|
|
// Items: A list of URL resources.
|
|
Items []*Url `json:"items,omitempty"`
|
|
|
|
// ItemsPerPage: Number of items returned with each full "page" of
|
|
// results. Note that the last page could have fewer items than the
|
|
// "itemsPerPage" value.
|
|
ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
|
|
|
|
// Kind: The fixed string "urlshortener#urlHistory".
|
|
Kind string `json:"kind,omitempty"`
|
|
|
|
// NextPageToken: A token to provide to get the next page of results.
|
|
NextPageToken string `json:"nextPageToken,omitempty"`
|
|
|
|
// TotalItems: Total number of short URLs associated with this user (may
|
|
// be approximate).
|
|
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:"-"`
|
|
|
|
// NullFields is a list of field names (e.g. "Items") to include in API
|
|
// requests with the JSON null value. By default, fields with empty
|
|
// values are omitted from API requests. However, any field with an
|
|
// empty value appearing in NullFields will be sent to the server as
|
|
// null. It is an error if a field in this list has a non-empty value.
|
|
// This may be used to include null fields in Patch requests.
|
|
NullFields []string `json:"-"`
|
|
}
|
|
|
|
func (s *UrlHistory) MarshalJSON() ([]byte, error) {
|
|
type noMethod UrlHistory
|
|
raw := noMethod(*s)
|
|
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
|
|
}
|
|
|
|
// method id "urlshortener.url.get":
|
|
|
|
type UrlGetCall struct {
|
|
s *Service
|
|
urlParams_ gensupport.URLParams
|
|
ifNoneMatch_ string
|
|
ctx_ context.Context
|
|
header_ http.Header
|
|
}
|
|
|
|
// Get: Expands a short URL or gets creation time and analytics.
|
|
func (r *UrlService) Get(shortUrl string) *UrlGetCall {
|
|
c := &UrlGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
|
|
c.urlParams_.Set("shortUrl", shortUrl)
|
|
return c
|
|
}
|
|
|
|
// Projection sets the optional parameter "projection": Additional
|
|
// information to return.
|
|
//
|
|
// Possible values:
|
|
// "ANALYTICS_CLICKS" - Returns only click counts.
|
|
// "ANALYTICS_TOP_STRINGS" - Returns only top string counts.
|
|
// "FULL" - Returns the creation timestamp and all available
|
|
// analytics.
|
|
func (c *UrlGetCall) Projection(projection string) *UrlGetCall {
|
|
c.urlParams_.Set("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 *UrlGetCall) Fields(s ...googleapi.Field) *UrlGetCall {
|
|
c.urlParams_.Set("fields", googleapi.CombineFields(s))
|
|
return c
|
|
}
|
|
|
|
// IfNoneMatch sets the optional parameter which makes the operation
|
|
// fail if the object's ETag matches the given value. This is useful for
|
|
// getting updates only after the object has changed since the last
|
|
// request. Use googleapi.IsNotModified to check whether the response
|
|
// error from Do is the result of In-None-Match.
|
|
func (c *UrlGetCall) IfNoneMatch(entityTag string) *UrlGetCall {
|
|
c.ifNoneMatch_ = entityTag
|
|
return c
|
|
}
|
|
|
|
// Context sets the context to be used in this call's Do method. Any
|
|
// pending HTTP request will be aborted if the provided context is
|
|
// canceled.
|
|
func (c *UrlGetCall) Context(ctx context.Context) *UrlGetCall {
|
|
c.ctx_ = ctx
|
|
return c
|
|
}
|
|
|
|
// Header returns an http.Header that can be modified by the caller to
|
|
// add HTTP headers to the request.
|
|
func (c *UrlGetCall) Header() http.Header {
|
|
if c.header_ == nil {
|
|
c.header_ = make(http.Header)
|
|
}
|
|
return c.header_
|
|
}
|
|
|
|
func (c *UrlGetCall) doRequest(alt string) (*http.Response, error) {
|
|
reqHeaders := make(http.Header)
|
|
for k, v := range c.header_ {
|
|
reqHeaders[k] = v
|
|
}
|
|
reqHeaders.Set("User-Agent", c.s.userAgent())
|
|
if c.ifNoneMatch_ != "" {
|
|
reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
|
|
}
|
|
var body io.Reader = nil
|
|
c.urlParams_.Set("alt", alt)
|
|
urls := googleapi.ResolveRelative(c.s.BasePath, "url")
|
|
urls += "?" + c.urlParams_.Encode()
|
|
req, _ := http.NewRequest("GET", urls, body)
|
|
req.Header = reqHeaders
|
|
return gensupport.SendRequest(c.ctx_, c.s.client, req)
|
|
}
|
|
|
|
// Do executes the "urlshortener.url.get" call.
|
|
// Exactly one of *Url or error will be non-nil. Any non-2xx status code
|
|
// is an error. Response headers are in either
|
|
// *Url.ServerResponse.Header or (if a response was returned at all) in
|
|
// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
|
|
// whether the returned error was because http.StatusNotModified was
|
|
// returned.
|
|
func (c *UrlGetCall) Do(opts ...googleapi.CallOption) (*Url, error) {
|
|
gensupport.SetOptions(c.urlParams_, opts...)
|
|
res, err := c.doRequest("json")
|
|
if res != nil && res.StatusCode == http.StatusNotModified {
|
|
if res.Body != nil {
|
|
res.Body.Close()
|
|
}
|
|
return nil, &googleapi.Error{
|
|
Code: res.StatusCode,
|
|
Header: res.Header,
|
|
}
|
|
}
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer googleapi.CloseBody(res)
|
|
if err := googleapi.CheckResponse(res); err != nil {
|
|
return nil, err
|
|
}
|
|
ret := &Url{
|
|
ServerResponse: googleapi.ServerResponse{
|
|
Header: res.Header,
|
|
HTTPStatusCode: res.StatusCode,
|
|
},
|
|
}
|
|
target := &ret
|
|
if err := json.NewDecoder(res.Body).Decode(target); err != nil {
|
|
return nil, err
|
|
}
|
|
return ret, nil
|
|
// {
|
|
// "description": "Expands a short URL or gets creation time and analytics.",
|
|
// "httpMethod": "GET",
|
|
// "id": "urlshortener.url.get",
|
|
// "parameterOrder": [
|
|
// "shortUrl"
|
|
// ],
|
|
// "parameters": {
|
|
// "projection": {
|
|
// "description": "Additional information to return.",
|
|
// "enum": [
|
|
// "ANALYTICS_CLICKS",
|
|
// "ANALYTICS_TOP_STRINGS",
|
|
// "FULL"
|
|
// ],
|
|
// "enumDescriptions": [
|
|
// "Returns only click counts.",
|
|
// "Returns only top string counts.",
|
|
// "Returns the creation timestamp and all available analytics."
|
|
// ],
|
|
// "location": "query",
|
|
// "type": "string"
|
|
// },
|
|
// "shortUrl": {
|
|
// "description": "The short URL, including the protocol.",
|
|
// "location": "query",
|
|
// "required": true,
|
|
// "type": "string"
|
|
// }
|
|
// },
|
|
// "path": "url",
|
|
// "response": {
|
|
// "$ref": "Url"
|
|
// },
|
|
// "scopes": [
|
|
// "https://www.googleapis.com/auth/urlshortener"
|
|
// ]
|
|
// }
|
|
|
|
}
|
|
|
|
// method id "urlshortener.url.insert":
|
|
|
|
type UrlInsertCall struct {
|
|
s *Service
|
|
url *Url
|
|
urlParams_ gensupport.URLParams
|
|
ctx_ context.Context
|
|
header_ http.Header
|
|
}
|
|
|
|
// Insert: Creates a new short URL.
|
|
func (r *UrlService) Insert(url *Url) *UrlInsertCall {
|
|
c := &UrlInsertCall{s: r.s, urlParams_: make(gensupport.URLParams)}
|
|
c.url = url
|
|
return c
|
|
}
|
|
|
|
// Fields allows partial responses to be retrieved. See
|
|
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
|
|
// for more information.
|
|
func (c *UrlInsertCall) Fields(s ...googleapi.Field) *UrlInsertCall {
|
|
c.urlParams_.Set("fields", googleapi.CombineFields(s))
|
|
return c
|
|
}
|
|
|
|
// Context sets the context to be used in this call's Do method. Any
|
|
// pending HTTP request will be aborted if the provided context is
|
|
// canceled.
|
|
func (c *UrlInsertCall) Context(ctx context.Context) *UrlInsertCall {
|
|
c.ctx_ = ctx
|
|
return c
|
|
}
|
|
|
|
// Header returns an http.Header that can be modified by the caller to
|
|
// add HTTP headers to the request.
|
|
func (c *UrlInsertCall) Header() http.Header {
|
|
if c.header_ == nil {
|
|
c.header_ = make(http.Header)
|
|
}
|
|
return c.header_
|
|
}
|
|
|
|
func (c *UrlInsertCall) doRequest(alt string) (*http.Response, error) {
|
|
reqHeaders := make(http.Header)
|
|
for k, v := range c.header_ {
|
|
reqHeaders[k] = v
|
|
}
|
|
reqHeaders.Set("User-Agent", c.s.userAgent())
|
|
var body io.Reader = nil
|
|
body, err := googleapi.WithoutDataWrapper.JSONReader(c.url)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
reqHeaders.Set("Content-Type", "application/json")
|
|
c.urlParams_.Set("alt", alt)
|
|
urls := googleapi.ResolveRelative(c.s.BasePath, "url")
|
|
urls += "?" + c.urlParams_.Encode()
|
|
req, _ := http.NewRequest("POST", urls, body)
|
|
req.Header = reqHeaders
|
|
return gensupport.SendRequest(c.ctx_, c.s.client, req)
|
|
}
|
|
|
|
// Do executes the "urlshortener.url.insert" call.
|
|
// Exactly one of *Url or error will be non-nil. Any non-2xx status code
|
|
// is an error. Response headers are in either
|
|
// *Url.ServerResponse.Header or (if a response was returned at all) in
|
|
// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
|
|
// whether the returned error was because http.StatusNotModified was
|
|
// returned.
|
|
func (c *UrlInsertCall) Do(opts ...googleapi.CallOption) (*Url, error) {
|
|
gensupport.SetOptions(c.urlParams_, opts...)
|
|
res, err := c.doRequest("json")
|
|
if res != nil && res.StatusCode == http.StatusNotModified {
|
|
if res.Body != nil {
|
|
res.Body.Close()
|
|
}
|
|
return nil, &googleapi.Error{
|
|
Code: res.StatusCode,
|
|
Header: res.Header,
|
|
}
|
|
}
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer googleapi.CloseBody(res)
|
|
if err := googleapi.CheckResponse(res); err != nil {
|
|
return nil, err
|
|
}
|
|
ret := &Url{
|
|
ServerResponse: googleapi.ServerResponse{
|
|
Header: res.Header,
|
|
HTTPStatusCode: res.StatusCode,
|
|
},
|
|
}
|
|
target := &ret
|
|
if err := json.NewDecoder(res.Body).Decode(target); err != nil {
|
|
return nil, err
|
|
}
|
|
return ret, nil
|
|
// {
|
|
// "description": "Creates a new short URL.",
|
|
// "httpMethod": "POST",
|
|
// "id": "urlshortener.url.insert",
|
|
// "path": "url",
|
|
// "request": {
|
|
// "$ref": "Url"
|
|
// },
|
|
// "response": {
|
|
// "$ref": "Url"
|
|
// },
|
|
// "scopes": [
|
|
// "https://www.googleapis.com/auth/urlshortener"
|
|
// ]
|
|
// }
|
|
|
|
}
|
|
|
|
// method id "urlshortener.url.list":
|
|
|
|
type UrlListCall struct {
|
|
s *Service
|
|
urlParams_ gensupport.URLParams
|
|
ifNoneMatch_ string
|
|
ctx_ context.Context
|
|
header_ http.Header
|
|
}
|
|
|
|
// List: Retrieves a list of URLs shortened by a user.
|
|
func (r *UrlService) List() *UrlListCall {
|
|
c := &UrlListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
|
|
return c
|
|
}
|
|
|
|
// Projection sets the optional parameter "projection": Additional
|
|
// information to return.
|
|
//
|
|
// Possible values:
|
|
// "ANALYTICS_CLICKS" - Returns short URL click counts.
|
|
// "FULL" - Returns short URL click counts.
|
|
func (c *UrlListCall) Projection(projection string) *UrlListCall {
|
|
c.urlParams_.Set("projection", projection)
|
|
return c
|
|
}
|
|
|
|
// StartToken sets the optional parameter "start-token": Token for
|
|
// requesting successive pages of results.
|
|
func (c *UrlListCall) StartToken(startToken string) *UrlListCall {
|
|
c.urlParams_.Set("start-token", startToken)
|
|
return c
|
|
}
|
|
|
|
// Fields allows partial responses to be retrieved. See
|
|
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
|
|
// for more information.
|
|
func (c *UrlListCall) Fields(s ...googleapi.Field) *UrlListCall {
|
|
c.urlParams_.Set("fields", googleapi.CombineFields(s))
|
|
return c
|
|
}
|
|
|
|
// IfNoneMatch sets the optional parameter which makes the operation
|
|
// fail if the object's ETag matches the given value. This is useful for
|
|
// getting updates only after the object has changed since the last
|
|
// request. Use googleapi.IsNotModified to check whether the response
|
|
// error from Do is the result of In-None-Match.
|
|
func (c *UrlListCall) IfNoneMatch(entityTag string) *UrlListCall {
|
|
c.ifNoneMatch_ = entityTag
|
|
return c
|
|
}
|
|
|
|
// Context sets the context to be used in this call's Do method. Any
|
|
// pending HTTP request will be aborted if the provided context is
|
|
// canceled.
|
|
func (c *UrlListCall) Context(ctx context.Context) *UrlListCall {
|
|
c.ctx_ = ctx
|
|
return c
|
|
}
|
|
|
|
// Header returns an http.Header that can be modified by the caller to
|
|
// add HTTP headers to the request.
|
|
func (c *UrlListCall) Header() http.Header {
|
|
if c.header_ == nil {
|
|
c.header_ = make(http.Header)
|
|
}
|
|
return c.header_
|
|
}
|
|
|
|
func (c *UrlListCall) doRequest(alt string) (*http.Response, error) {
|
|
reqHeaders := make(http.Header)
|
|
for k, v := range c.header_ {
|
|
reqHeaders[k] = v
|
|
}
|
|
reqHeaders.Set("User-Agent", c.s.userAgent())
|
|
if c.ifNoneMatch_ != "" {
|
|
reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
|
|
}
|
|
var body io.Reader = nil
|
|
c.urlParams_.Set("alt", alt)
|
|
urls := googleapi.ResolveRelative(c.s.BasePath, "url/history")
|
|
urls += "?" + c.urlParams_.Encode()
|
|
req, _ := http.NewRequest("GET", urls, body)
|
|
req.Header = reqHeaders
|
|
return gensupport.SendRequest(c.ctx_, c.s.client, req)
|
|
}
|
|
|
|
// Do executes the "urlshortener.url.list" call.
|
|
// Exactly one of *UrlHistory or error will be non-nil. Any non-2xx
|
|
// status code is an error. Response headers are in either
|
|
// *UrlHistory.ServerResponse.Header or (if a response was returned at
|
|
// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
|
|
// to check whether the returned error was because
|
|
// http.StatusNotModified was returned.
|
|
func (c *UrlListCall) Do(opts ...googleapi.CallOption) (*UrlHistory, error) {
|
|
gensupport.SetOptions(c.urlParams_, opts...)
|
|
res, err := c.doRequest("json")
|
|
if res != nil && res.StatusCode == http.StatusNotModified {
|
|
if res.Body != nil {
|
|
res.Body.Close()
|
|
}
|
|
return nil, &googleapi.Error{
|
|
Code: res.StatusCode,
|
|
Header: res.Header,
|
|
}
|
|
}
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer googleapi.CloseBody(res)
|
|
if err := googleapi.CheckResponse(res); err != nil {
|
|
return nil, err
|
|
}
|
|
ret := &UrlHistory{
|
|
ServerResponse: googleapi.ServerResponse{
|
|
Header: res.Header,
|
|
HTTPStatusCode: res.StatusCode,
|
|
},
|
|
}
|
|
target := &ret
|
|
if err := json.NewDecoder(res.Body).Decode(target); err != nil {
|
|
return nil, err
|
|
}
|
|
return ret, nil
|
|
// {
|
|
// "description": "Retrieves a list of URLs shortened by a user.",
|
|
// "httpMethod": "GET",
|
|
// "id": "urlshortener.url.list",
|
|
// "parameters": {
|
|
// "projection": {
|
|
// "description": "Additional information to return.",
|
|
// "enum": [
|
|
// "ANALYTICS_CLICKS",
|
|
// "FULL"
|
|
// ],
|
|
// "enumDescriptions": [
|
|
// "Returns short URL click counts.",
|
|
// "Returns short URL click counts."
|
|
// ],
|
|
// "location": "query",
|
|
// "type": "string"
|
|
// },
|
|
// "start-token": {
|
|
// "description": "Token for requesting successive pages of results.",
|
|
// "location": "query",
|
|
// "type": "string"
|
|
// }
|
|
// },
|
|
// "path": "url/history",
|
|
// "response": {
|
|
// "$ref": "UrlHistory"
|
|
// },
|
|
// "scopes": [
|
|
// "https://www.googleapis.com/auth/urlshortener"
|
|
// ]
|
|
// }
|
|
|
|
}
|