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 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
|
// Package pagespeedonline provides access to the PageSpeed Insights API.
//
// See https://developers.google.com/speed/docs/insights/v2/getting-started
//
// Usage example:
//
// import "google.golang.org/api/pagespeedonline/v2"
// ...
// pagespeedonlineService, err := pagespeedonline.New(oauthHttpClient)
package pagespeedonline
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"golang.org/x/net/context"
"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 _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Background
const apiId = "pagespeedonline:v2"
const apiName = "pagespeedonline"
const apiVersion = "v2"
const basePath = "https://www.googleapis.com/pagespeedonline/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.Pagespeedapi = NewPagespeedapiService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Pagespeedapi *PagespeedapiService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewPagespeedapiService(s *Service) *PagespeedapiService {
rs := &PagespeedapiService{s: s}
return rs
}
type PagespeedapiService struct {
s *Service
}
type PagespeedApiFormatStringV2 struct {
// Args: List of arguments for the format string.
Args []*PagespeedApiFormatStringV2Args `json:"args,omitempty"`
// Format: A localized format string with {{FOO}} placeholders, where
// 'FOO' is the key of the argument whose value should be substituted.
// For HYPERLINK arguments, the format string will instead contain
// {{BEGIN_FOO}} and {{END_FOO}} for the argument with key 'FOO'.
Format string `json:"format,omitempty"`
}
type PagespeedApiFormatStringV2Args struct {
// Key: The placeholder key for this arg, as a string.
Key string `json:"key,omitempty"`
// Rects: The screen rectangles being referred to, with dimensions
// measured in CSS pixels. This is only ever used for SNAPSHOT_RECT
// arguments. If this is absent for a SNAPSHOT_RECT argument, it means
// that that argument refers to the entire snapshot.
Rects []*PagespeedApiFormatStringV2ArgsRects `json:"rects,omitempty"`
// SecondaryRects: Secondary screen rectangles being referred to, with
// dimensions measured in CSS pixels. This is only ever used for
// SNAPSHOT_RECT arguments.
SecondaryRects []*PagespeedApiFormatStringV2ArgsSecondaryRects `json:"secondary_rects,omitempty"`
// Type: Type of argument. One of URL, STRING_LITERAL, INT_LITERAL,
// BYTES, DURATION, VERBATIM_STRING, PERCENTAGE, HYPERLINK, or
// SNAPSHOT_RECT.
Type string `json:"type,omitempty"`
// Value: Argument value, as a localized string.
Value string `json:"value,omitempty"`
}
type PagespeedApiFormatStringV2ArgsRects struct {
// Height: The height of the rect.
Height int64 `json:"height,omitempty"`
// Left: The left coordinate of the rect, in page coordinates.
Left int64 `json:"left,omitempty"`
// Top: The top coordinate of the rect, in page coordinates.
Top int64 `json:"top,omitempty"`
// Width: The width of the rect.
Width int64 `json:"width,omitempty"`
}
type PagespeedApiFormatStringV2ArgsSecondaryRects struct {
// Height: The height of the rect.
Height int64 `json:"height,omitempty"`
// Left: The left coordinate of the rect, in page coordinates.
Left int64 `json:"left,omitempty"`
// Top: The top coordinate of the rect, in page coordinates.
Top int64 `json:"top,omitempty"`
// Width: The width of the rect.
Width int64 `json:"width,omitempty"`
}
type PagespeedApiImageV2 struct {
// Data: Image data base64 encoded.
Data string `json:"data,omitempty"`
// Height: Height of screenshot in pixels.
Height int64 `json:"height,omitempty"`
// Key: Unique string key, if any, identifying this image.
Key string `json:"key,omitempty"`
// MimeType: Mime type of image data (e.g. "image/jpeg").
MimeType string `json:"mime_type,omitempty"`
// PageRect: The region of the page that is captured by this image, with
// dimensions measured in CSS pixels.
PageRect *PagespeedApiImageV2PageRect `json:"page_rect,omitempty"`
// Width: Width of screenshot in pixels.
Width int64 `json:"width,omitempty"`
}
type PagespeedApiImageV2PageRect struct {
// Height: The height of the rect.
Height int64 `json:"height,omitempty"`
// Left: The left coordinate of the rect, in page coordinates.
Left int64 `json:"left,omitempty"`
// Top: The top coordinate of the rect, in page coordinates.
Top int64 `json:"top,omitempty"`
// Width: The width of the rect.
Width int64 `json:"width,omitempty"`
}
type Result struct {
// FormattedResults: Localized PageSpeed results. Contains a ruleResults
// entry for each PageSpeed rule instantiated and run by the server.
FormattedResults *ResultFormattedResults `json:"formattedResults,omitempty"`
// Id: Canonicalized and final URL for the document, after following
// page redirects (if any).
Id string `json:"id,omitempty"`
// InvalidRules: List of rules that were specified in the request, but
// which the server did not know how to instantiate.
InvalidRules []string `json:"invalidRules,omitempty"`
// Kind: Kind of result.
Kind string `json:"kind,omitempty"`
// PageStats: Summary statistics for the page, such as number of
// JavaScript bytes, number of HTML bytes, etc.
PageStats *ResultPageStats `json:"pageStats,omitempty"`
// ResponseCode: Response code for the document. 200 indicates a normal
// page load. 4xx/5xx indicates an error.
ResponseCode int64 `json:"responseCode,omitempty"`
// RuleGroups: A map with one entry for each rule group in these
// results.
RuleGroups *ResultRuleGroups `json:"ruleGroups,omitempty"`
// Screenshot: Base64-encoded screenshot of the page that was analyzed.
Screenshot *PagespeedApiImageV2 `json:"screenshot,omitempty"`
// Title: Title of the page, as displayed in the browser's title bar.
Title string `json:"title,omitempty"`
// Version: The version of PageSpeed used to generate these results.
Version *ResultVersion `json:"version,omitempty"`
}
type ResultFormattedResults struct {
// Locale: The locale of the formattedResults, e.g. "en_US".
Locale string `json:"locale,omitempty"`
// RuleResults: Dictionary of formatted rule results, with one entry for
// each PageSpeed rule instantiated and run by the server.
RuleResults *ResultFormattedResultsRuleResults `json:"ruleResults,omitempty"`
}
type ResultFormattedResultsRuleResults struct {
}
type ResultPageStats struct {
// CssResponseBytes: Number of uncompressed response bytes for CSS
// resources on the page.
CssResponseBytes int64 `json:"cssResponseBytes,omitempty,string"`
// FlashResponseBytes: Number of response bytes for flash resources on
// the page.
FlashResponseBytes int64 `json:"flashResponseBytes,omitempty,string"`
// HtmlResponseBytes: Number of uncompressed response bytes for the main
// HTML document and all iframes on the page.
HtmlResponseBytes int64 `json:"htmlResponseBytes,omitempty,string"`
// ImageResponseBytes: Number of response bytes for image resources on
// the page.
ImageResponseBytes int64 `json:"imageResponseBytes,omitempty,string"`
// JavascriptResponseBytes: Number of uncompressed response bytes for JS
// resources on the page.
JavascriptResponseBytes int64 `json:"javascriptResponseBytes,omitempty,string"`
// NumberCssResources: Number of CSS resources referenced by the page.
NumberCssResources int64 `json:"numberCssResources,omitempty"`
// NumberHosts: Number of unique hosts referenced by the page.
NumberHosts int64 `json:"numberHosts,omitempty"`
// NumberJsResources: Number of JavaScript resources referenced by the
// page.
NumberJsResources int64 `json:"numberJsResources,omitempty"`
// NumberResources: Number of HTTP resources loaded by the page.
NumberResources int64 `json:"numberResources,omitempty"`
// NumberStaticResources: Number of static (i.e. cacheable) resources on
// the page.
NumberStaticResources int64 `json:"numberStaticResources,omitempty"`
// OtherResponseBytes: Number of response bytes for other resources on
// the page.
OtherResponseBytes int64 `json:"otherResponseBytes,omitempty,string"`
// TextResponseBytes: Number of uncompressed response bytes for text
// resources not covered by other statistics (i.e non-HTML, non-script,
// non-CSS resources) on the page.
TextResponseBytes int64 `json:"textResponseBytes,omitempty,string"`
// TotalRequestBytes: Total size of all request bytes sent by the page.
TotalRequestBytes int64 `json:"totalRequestBytes,omitempty,string"`
}
type ResultRuleGroups struct {
}
type ResultVersion struct {
// Major: The major version number of PageSpeed used to generate these
// results.
Major int64 `json:"major,omitempty"`
// Minor: The minor version number of PageSpeed used to generate these
// results.
Minor int64 `json:"minor,omitempty"`
}
// method id "pagespeedonline.pagespeedapi.runpagespeed":
type PagespeedapiRunpagespeedCall struct {
s *Service
url string
opt_ map[string]interface{}
}
// Runpagespeed: Runs PageSpeed analysis on the page at the specified
// URL, and returns PageSpeed scores, a list of suggestions to make that
// page faster, and other information.
func (r *PagespeedapiService) Runpagespeed(url string) *PagespeedapiRunpagespeedCall {
c := &PagespeedapiRunpagespeedCall{s: r.s, opt_: make(map[string]interface{})}
c.url = url
return c
}
// FilterThirdPartyResources sets the optional parameter
// "filter_third_party_resources": Indicates if third party resources
// should be filtered out before PageSpeed analysis.
func (c *PagespeedapiRunpagespeedCall) FilterThirdPartyResources(filterThirdPartyResources bool) *PagespeedapiRunpagespeedCall {
c.opt_["filter_third_party_resources"] = filterThirdPartyResources
return c
}
// Locale sets the optional parameter "locale": The locale used to
// localize formatted results
func (c *PagespeedapiRunpagespeedCall) Locale(locale string) *PagespeedapiRunpagespeedCall {
c.opt_["locale"] = locale
return c
}
// Rule sets the optional parameter "rule": A PageSpeed rule to run; if
// none are given, all rules are run
func (c *PagespeedapiRunpagespeedCall) Rule(rule string) *PagespeedapiRunpagespeedCall {
c.opt_["rule"] = rule
return c
}
// Screenshot sets the optional parameter "screenshot": Indicates if
// binary data containing a screenshot should be included
func (c *PagespeedapiRunpagespeedCall) Screenshot(screenshot bool) *PagespeedapiRunpagespeedCall {
c.opt_["screenshot"] = screenshot
return c
}
// Strategy sets the optional parameter "strategy": The analysis
// strategy to use
//
// Possible values:
// "desktop" - Fetch and analyze the URL for desktop browsers
// "mobile" - Fetch and analyze the URL for mobile devices
func (c *PagespeedapiRunpagespeedCall) Strategy(strategy string) *PagespeedapiRunpagespeedCall {
c.opt_["strategy"] = strategy
return c
}
// Fields allows partial responses to be retrieved.
// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *PagespeedapiRunpagespeedCall) Fields(s ...googleapi.Field) *PagespeedapiRunpagespeedCall {
c.opt_["fields"] = googleapi.CombineFields(s)
return c
}
func (c *PagespeedapiRunpagespeedCall) Do() (*Result, error) {
var body io.Reader = nil
params := make(url.Values)
params.Set("alt", "json")
params.Set("url", fmt.Sprintf("%v", c.url))
if v, ok := c.opt_["filter_third_party_resources"]; ok {
params.Set("filter_third_party_resources", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["locale"]; ok {
params.Set("locale", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["rule"]; ok {
params.Set("rule", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["screenshot"]; ok {
params.Set("screenshot", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["strategy"]; ok {
params.Set("strategy", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["fields"]; ok {
params.Set("fields", fmt.Sprintf("%v", v))
}
urls := googleapi.ResolveRelative(c.s.BasePath, "runPagespeed")
urls += "?" + params.Encode()
req, _ := http.NewRequest("GET", urls, body)
googleapi.SetOpaque(req.URL)
req.Header.Set("User-Agent", c.s.userAgent())
res, err := c.s.client.Do(req)
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, err
}
var ret *Result
if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
return nil, err
}
return ret, nil
// {
// "description": "Runs PageSpeed analysis on the page at the specified URL, and returns PageSpeed scores, a list of suggestions to make that page faster, and other information.",
// "httpMethod": "GET",
// "id": "pagespeedonline.pagespeedapi.runpagespeed",
// "parameterOrder": [
// "url"
// ],
// "parameters": {
// "filter_third_party_resources": {
// "default": "false",
// "description": "Indicates if third party resources should be filtered out before PageSpeed analysis.",
// "location": "query",
// "type": "boolean"
// },
// "locale": {
// "description": "The locale used to localize formatted results",
// "location": "query",
// "pattern": "[a-zA-Z]+(_[a-zA-Z]+)?",
// "type": "string"
// },
// "rule": {
// "description": "A PageSpeed rule to run; if none are given, all rules are run",
// "location": "query",
// "pattern": "[a-zA-Z]+",
// "repeated": true,
// "type": "string"
// },
// "screenshot": {
// "default": "false",
// "description": "Indicates if binary data containing a screenshot should be included",
// "location": "query",
// "type": "boolean"
// },
// "strategy": {
// "description": "The analysis strategy to use",
// "enum": [
// "desktop",
// "mobile"
// ],
// "enumDescriptions": [
// "Fetch and analyze the URL for desktop browsers",
// "Fetch and analyze the URL for mobile devices"
// ],
// "location": "query",
// "type": "string"
// },
// "url": {
// "description": "The URL to fetch and analyze",
// "location": "query",
// "pattern": "http(s)?://.*",
// "required": true,
// "type": "string"
// }
// },
// "path": "runPagespeed",
// "response": {
// "$ref": "Result"
// }
// }
}
|