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 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
use std::collections::HashMap;
use std::cell::RefCell;
use std::default::Default;
use std::collections::BTreeSet;
use std::error::Error as StdError;
use serde_json as json;
use std::io;
use std::fs;
use std::mem;
use hyper::client::connect;
use tokio::io::{AsyncRead, AsyncWrite};
use tokio::time::sleep;
use tower_service;
use serde::{Serialize, Deserialize};
use crate::{client, client::GetToken, client::serde_with};
// ##############
// UTILITIES ###
// ############
/// Identifies the an OAuth2 authorization scope.
/// A scope is needed when requesting an
/// [authorization token](https://developers.google.com/youtube/v3/guides/authentication).
#[derive(PartialEq, Eq, Ord, PartialOrd, Hash, Debug, Clone, Copy)]
pub enum Scope {
/// Associate you with your personal info on Google
Openid,
}
impl AsRef<str> for Scope {
fn as_ref(&self) -> &str {
match *self {
Scope::Openid => "openid",
}
}
}
impl Default for Scope {
fn default() -> Scope {
Scope::Openid
}
}
// ########
// HUB ###
// ######
/// Central instance to access all PagespeedInsights related resource activities
///
/// # Examples
///
/// Instantiate a new hub
///
/// ```test_harness,no_run
/// extern crate hyper;
/// extern crate hyper_rustls;
/// extern crate google_pagespeedonline5 as pagespeedonline5;
/// use pagespeedonline5::{Result, Error};
/// # async fn dox() {
/// use std::default::Default;
/// use pagespeedonline5::{PagespeedInsights, oauth2, hyper, hyper_rustls, chrono, FieldMask};
///
/// // Get an ApplicationSecret instance by some means. It contains the `client_id` and
/// // `client_secret`, among other things.
/// let secret: oauth2::ApplicationSecret = Default::default();
/// // Instantiate the authenticator. It will choose a suitable authentication flow for you,
/// // unless you replace `None` with the desired Flow.
/// // Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about
/// // what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
/// // retrieve them from storage.
/// let auth = oauth2::InstalledFlowAuthenticator::builder(
/// secret,
/// oauth2::InstalledFlowReturnMethod::HTTPRedirect,
/// ).build().await.unwrap();
/// let mut hub = PagespeedInsights::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
/// // You can configure optional parameters by calling the respective setters at will, and
/// // execute the final call using `doit()`.
/// // Values shown here are possibly random and not representative !
/// let result = hub.pagespeedapi().runpagespeed("url")
/// .utm_source("gubergren")
/// .utm_campaign("eos")
/// .strategy("dolor")
/// .locale("ea")
/// .add_category("ipsum")
/// .captcha_token("invidunt")
/// .doit().await;
///
/// match result {
/// Err(e) => match e {
/// // The Error enum provides details about what exactly happened.
/// // You can also just use its `Debug`, `Display` or `Error` traits
/// Error::HttpError(_)
/// |Error::Io(_)
/// |Error::MissingAPIKey
/// |Error::MissingToken(_)
/// |Error::Cancelled
/// |Error::UploadSizeLimitExceeded(_, _)
/// |Error::Failure(_)
/// |Error::BadRequest(_)
/// |Error::FieldClash(_)
/// |Error::JsonDecodeError(_, _) => println!("{}", e),
/// },
/// Ok(res) => println!("Success: {:?}", res),
/// }
/// # }
/// ```
#[derive(Clone)]
pub struct PagespeedInsights<S> {
pub client: hyper::Client<S, hyper::body::Body>,
pub auth: Box<dyn client::GetToken>,
_user_agent: String,
_base_url: String,
_root_url: String,
}
impl<'a, S> client::Hub for PagespeedInsights<S> {}
impl<'a, S> PagespeedInsights<S> {
pub fn new<A: 'static + client::GetToken>(client: hyper::Client<S, hyper::body::Body>, auth: A) -> PagespeedInsights<S> {
PagespeedInsights {
client,
auth: Box::new(auth),
_user_agent: "google-api-rust-client/5.0.4".to_string(),
_base_url: "https://pagespeedonline.googleapis.com/".to_string(),
_root_url: "https://pagespeedonline.googleapis.com/".to_string(),
}
}
pub fn pagespeedapi(&'a self) -> PagespeedapiMethods<'a, S> {
PagespeedapiMethods { hub: &self }
}
/// Set the user-agent header field to use in all requests to the server.
/// It defaults to `google-api-rust-client/5.0.4`.
///
/// Returns the previously set user-agent.
pub fn user_agent(&mut self, agent_name: String) -> String {
mem::replace(&mut self._user_agent, agent_name)
}
/// Set the base url to use in all requests to the server.
/// It defaults to `https://pagespeedonline.googleapis.com/`.
///
/// Returns the previously set base url.
pub fn base_url(&mut self, new_base_url: String) -> String {
mem::replace(&mut self._base_url, new_base_url)
}
/// Set the root url to use in all requests to the server.
/// It defaults to `https://pagespeedonline.googleapis.com/`.
///
/// Returns the previously set root url.
pub fn root_url(&mut self, new_root_url: String) -> String {
mem::replace(&mut self._root_url, new_root_url)
}
}
// ############
// SCHEMAS ###
// ##########
/// A light reference to an audit by id, used to group and weight audits in a given category.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct AuditRefs {
/// The conventional acronym for the audit/metric.
pub acronym: Option<String>,
/// The category group that the audit belongs to (optional).
pub group: Option<String>,
/// The audit ref id.
pub id: Option<String>,
/// Any audit IDs closely relevant to this one.
#[serde(rename="relevantAudits")]
pub relevant_audits: Option<Vec<String>>,
/// The weight this audit's score has on the overall category score.
pub weight: Option<f64>,
}
impl client::Part for AuditRefs {}
/// A proportion of data in the total distribution, bucketed by a min/max percentage. Each bucket's range is bounded by min <= x < max, In millisecond.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct Bucket {
/// Upper bound for a bucket's range.
pub max: Option<i32>,
/// Lower bound for a bucket's range.
pub min: Option<i32>,
/// The proportion of data in this bucket.
pub proportion: Option<f64>,
}
impl client::Part for Bucket {}
/// The categories in a Lighthouse run.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct Categories {
/// The accessibility category, containing all accessibility related audits.
pub accessibility: Option<LighthouseCategoryV5>,
/// The best practices category, containing all best practices related audits.
#[serde(rename="best-practices")]
pub best_practices: Option<LighthouseCategoryV5>,
/// The performance category, containing all performance related audits.
pub performance: Option<LighthouseCategoryV5>,
/// The Progressive-Web-App (PWA) category, containing all pwa related audits.
pub pwa: Option<LighthouseCategoryV5>,
/// The Search-Engine-Optimization (SEO) category, containing all seo related audits.
pub seo: Option<LighthouseCategoryV5>,
}
impl client::Part for Categories {}
/// Message containing a category
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct CategoryGroupV5 {
/// The description of what the category is grouping
pub description: Option<String>,
/// The human readable title of the group
pub title: Option<String>,
}
impl client::Part for CategoryGroupV5 {}
/// Message containing the configuration settings for the Lighthouse run.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct ConfigSettings {
/// How Lighthouse was run, e.g. from the Chrome extension or from the npm module.
pub channel: Option<String>,
/// The form factor the emulation should use. This field is deprecated, form_factor should be used instead.
#[serde(rename="emulatedFormFactor")]
pub emulated_form_factor: Option<String>,
/// How Lighthouse should interpret this run in regards to scoring performance metrics and skipping mobile-only tests in desktop.
#[serde(rename="formFactor")]
pub form_factor: Option<String>,
/// The locale setting.
pub locale: Option<String>,
/// List of categories of audits the run should conduct.
#[serde(rename="onlyCategories")]
pub only_categories: Option<json::Value>,
}
impl client::Part for ConfigSettings {}
/// Message containing environment configuration for a Lighthouse run.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct Environment {
/// The benchmark index number that indicates rough device class.
#[serde(rename="benchmarkIndex")]
pub benchmark_index: Option<f64>,
/// The version of libraries with which these results were generated. Ex: axe-core.
pub credits: Option<HashMap<String, String>>,
/// The user agent string of the version of Chrome used.
#[serde(rename="hostUserAgent")]
pub host_user_agent: Option<String>,
/// The user agent string that was sent over the network.
#[serde(rename="networkUserAgent")]
pub network_user_agent: Option<String>,
}
impl client::Part for Environment {}
/// Message containing the i18n data for the LHR - Version 1.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct I18n {
/// Internationalized strings that are formatted to the locale in configSettings.
#[serde(rename="rendererFormattedStrings")]
pub renderer_formatted_strings: Option<RendererFormattedStrings>,
}
impl client::Part for I18n {}
/// Message containing an Entity.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct LhrEntity {
/// Optional. An optional category name for the entity.
pub category: Option<String>,
/// Optional. An optional homepage URL of the entity.
pub homepage: Option<String>,
/// Optional. An optional flag indicating if the entity is the first party.
#[serde(rename="isFirstParty")]
pub is_first_party: Option<bool>,
/// Optional. An optional flag indicating if the entity is not recognized.
#[serde(rename="isUnrecognized")]
pub is_unrecognized: Option<bool>,
/// Required. Name of the entity.
pub name: Option<String>,
/// Required. A list of URL origin strings that belong to this entity.
pub origins: Option<Vec<String>>,
}
impl client::Part for LhrEntity {}
/// An audit's result object in a Lighthouse result.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct LighthouseAuditResultV5 {
/// The description of the audit.
pub description: Option<String>,
/// Freeform details section of the audit.
pub details: Option<HashMap<String, json::Value>>,
/// The value that should be displayed on the UI for this audit.
#[serde(rename="displayValue")]
pub display_value: Option<String>,
/// An error message from a thrown error inside the audit.
#[serde(rename="errorMessage")]
pub error_message: Option<String>,
/// An explanation of the errors in the audit.
pub explanation: Option<String>,
/// The audit's id.
pub id: Option<String>,
/// The unit of the numeric_value field. Used to format the numeric value for display.
#[serde(rename="numericUnit")]
pub numeric_unit: Option<String>,
/// A numeric value that has a meaning specific to the audit, e.g. the number of nodes in the DOM or the timestamp of a specific load event. More information can be found in the audit details, if present.
#[serde(rename="numericValue")]
pub numeric_value: Option<f64>,
/// The score of the audit, can be null.
pub score: Option<json::Value>,
/// The enumerated score display mode.
#[serde(rename="scoreDisplayMode")]
pub score_display_mode: Option<String>,
/// The human readable title.
pub title: Option<String>,
/// Possible warnings that occurred in the audit, can be null.
pub warnings: Option<json::Value>,
}
impl client::Part for LighthouseAuditResultV5 {}
/// A Lighthouse category.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct LighthouseCategoryV5 {
/// An array of references to all the audit members of this category.
#[serde(rename="auditRefs")]
pub audit_refs: Option<Vec<AuditRefs>>,
/// A more detailed description of the category and its importance.
pub description: Option<String>,
/// The string identifier of the category.
pub id: Option<String>,
/// A description for the manual audits in the category.
#[serde(rename="manualDescription")]
pub manual_description: Option<String>,
/// The overall score of the category, the weighted average of all its audits. (The category's score, can be null.)
pub score: Option<json::Value>,
/// The human-friendly name of the category.
pub title: Option<String>,
}
impl client::Part for LighthouseCategoryV5 {}
/// The Lighthouse result object.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct LighthouseResultV5 {
/// Map of audits in the LHR.
pub audits: Option<HashMap<String, LighthouseAuditResultV5>>,
/// Map of categories in the LHR.
pub categories: Option<Categories>,
/// Map of category groups in the LHR.
#[serde(rename="categoryGroups")]
pub category_groups: Option<HashMap<String, CategoryGroupV5>>,
/// The configuration settings for this LHR.
#[serde(rename="configSettings")]
pub config_settings: Option<ConfigSettings>,
/// Entity classification data.
pub entities: Option<Vec<LhrEntity>>,
/// Environment settings that were used when making this LHR.
pub environment: Option<Environment>,
/// The time that this run was fetched.
#[serde(rename="fetchTime")]
pub fetch_time: Option<String>,
/// URL displayed on the page after Lighthouse finishes.
#[serde(rename="finalDisplayedUrl")]
pub final_displayed_url: Option<String>,
/// The final resolved url that was audited.
#[serde(rename="finalUrl")]
pub final_url: Option<String>,
/// Screenshot data of the full page, along with node rects relevant to the audit results.
#[serde(rename="fullPageScreenshot")]
pub full_page_screenshot: Option<json::Value>,
/// The internationalization strings that are required to render the LHR.
pub i18n: Option<I18n>,
/// The lighthouse version that was used to generate this LHR.
#[serde(rename="lighthouseVersion")]
pub lighthouse_version: Option<String>,
/// URL of the main document request of the final navigation.
#[serde(rename="mainDocumentUrl")]
pub main_document_url: Option<String>,
/// The original requested url.
#[serde(rename="requestedUrl")]
pub requested_url: Option<String>,
/// List of all run warnings in the LHR. Will always output to at least `[]`.
#[serde(rename="runWarnings")]
pub run_warnings: Option<Vec<json::Value>>,
/// A top-level error message that, if present, indicates a serious enough problem that this Lighthouse result may need to be discarded.
#[serde(rename="runtimeError")]
pub runtime_error: Option<RuntimeError>,
/// The Stack Pack advice strings.
#[serde(rename="stackPacks")]
pub stack_packs: Option<Vec<StackPack>>,
/// Timing information for this LHR.
pub timing: Option<Timing>,
/// The user agent that was used to run this LHR.
#[serde(rename="userAgent")]
pub user_agent: Option<String>,
}
impl client::Part for LighthouseResultV5 {}
/// The CrUX loading experience object that contains CrUX data breakdowns.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct PagespeedApiLoadingExperienceV5 {
/// The url, pattern or origin which the metrics are on.
pub id: Option<String>,
/// The requested URL, which may differ from the resolved "id".
pub initial_url: Option<String>,
/// The map of .
pub metrics: Option<HashMap<String, UserPageLoadMetricV5>>,
/// True if the result is an origin fallback from a page, false otherwise.
pub origin_fallback: Option<bool>,
/// The human readable speed "category" of the id.
pub overall_category: Option<String>,
}
impl client::Part for PagespeedApiLoadingExperienceV5 {}
/// The Pagespeed API response object.
///
/// # Activities
///
/// This type is used in activities, which are methods you may call on this type or where this type is involved in.
/// The list links the activity name, along with information about where it is used (one of *request* and *response*).
///
/// * [runpagespeed pagespeedapi](PagespeedapiRunpagespeedCall) (response)
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct PagespeedApiPagespeedResponseV5 {
/// The UTC timestamp of this analysis.
#[serde(rename="analysisUTCTimestamp")]
pub analysis_utc_timestamp: Option<String>,
/// The captcha verify result
#[serde(rename="captchaResult")]
pub captcha_result: Option<String>,
/// Canonicalized and final URL for the document, after following page redirects (if any).
pub id: Option<String>,
/// Kind of result.
pub kind: Option<String>,
/// Lighthouse response for the audit url as an object.
#[serde(rename="lighthouseResult")]
pub lighthouse_result: Option<LighthouseResultV5>,
/// Metrics of end users' page loading experience.
#[serde(rename="loadingExperience")]
pub loading_experience: Option<PagespeedApiLoadingExperienceV5>,
/// Metrics of the aggregated page loading experience of the origin
#[serde(rename="originLoadingExperience")]
pub origin_loading_experience: Option<PagespeedApiLoadingExperienceV5>,
/// The version of PageSpeed used to generate these results.
pub version: Option<PagespeedVersion>,
}
impl client::ResponseResult for PagespeedApiPagespeedResponseV5 {}
/// The Pagespeed Version object.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct PagespeedVersion {
/// The major version number of PageSpeed used to generate these results.
pub major: Option<String>,
/// The minor version number of PageSpeed used to generate these results.
pub minor: Option<String>,
}
impl client::Part for PagespeedVersion {}
/// Message holding the formatted strings used in the renderer.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct RendererFormattedStrings {
/// The tooltip text on an expandable chevron icon.
#[serde(rename="auditGroupExpandTooltip")]
pub audit_group_expand_tooltip: Option<String>,
/// Text link pointing to the Lighthouse scoring calculator. This link immediately follows a sentence stating the performance score is calculated from the perf metrics.
#[serde(rename="calculatorLink")]
pub calculator_link: Option<String>,
/// The label for the initial request in a critical request chain.
#[serde(rename="crcInitialNavigation")]
pub crc_initial_navigation: Option<String>,
/// The label for values shown in the summary of critical request chains.
#[serde(rename="crcLongestDurationLabel")]
pub crc_longest_duration_label: Option<String>,
/// Option in a dropdown menu that copies the Lighthouse JSON object to the system clipboard.
#[serde(rename="dropdownCopyJSON")]
pub dropdown_copy_json: Option<String>,
/// Option in a dropdown menu that toggles the themeing of the report between Light(default) and Dark themes.
#[serde(rename="dropdownDarkTheme")]
pub dropdown_dark_theme: Option<String>,
/// Option in a dropdown menu that opens a full Lighthouse report in a print dialog.
#[serde(rename="dropdownPrintExpanded")]
pub dropdown_print_expanded: Option<String>,
/// Option in a dropdown menu that opens a small, summary report in a print dialog.
#[serde(rename="dropdownPrintSummary")]
pub dropdown_print_summary: Option<String>,
/// Option in a dropdown menu that saves the current report as a new GitHub Gist.
#[serde(rename="dropdownSaveGist")]
pub dropdown_save_gist: Option<String>,
/// Option in a dropdown menu that saves the Lighthouse report HTML locally to the system as a '.html' file.
#[serde(rename="dropdownSaveHTML")]
pub dropdown_save_html: Option<String>,
/// Option in a dropdown menu that saves the Lighthouse JSON object to the local system as a '.json' file.
#[serde(rename="dropdownSaveJSON")]
pub dropdown_save_json: Option<String>,
/// Option in a dropdown menu that opens the current report in the Lighthouse Viewer Application.
#[serde(rename="dropdownViewer")]
pub dropdown_viewer: Option<String>,
/// The label shown next to an audit or metric that has had an error.
#[serde(rename="errorLabel")]
pub error_label: Option<String>,
/// The error string shown next to an erroring audit.
#[serde(rename="errorMissingAuditInfo")]
pub error_missing_audit_info: Option<String>,
/// Label for button to create an issue against the Lighthouse GitHub project.
#[serde(rename="footerIssue")]
pub footer_issue: Option<String>,
/// The title of the lab data performance category.
#[serde(rename="labDataTitle")]
pub lab_data_title: Option<String>,
/// The disclaimer shown under performance explaining that the network can vary.
#[serde(rename="lsPerformanceCategoryDescription")]
pub ls_performance_category_description: Option<String>,
/// The heading shown above a list of audits that were not computerd in the run.
#[serde(rename="manualAuditsGroupTitle")]
pub manual_audits_group_title: Option<String>,
/// The heading shown above a list of audits that do not apply to a page.
#[serde(rename="notApplicableAuditsGroupTitle")]
pub not_applicable_audits_group_title: Option<String>,
/// The heading for the estimated page load savings opportunity of an audit.
#[serde(rename="opportunityResourceColumnLabel")]
pub opportunity_resource_column_label: Option<String>,
/// The heading for the estimated page load savings of opportunity audits.
#[serde(rename="opportunitySavingsColumnLabel")]
pub opportunity_savings_column_label: Option<String>,
/// The heading that is shown above a list of audits that are passing.
#[serde(rename="passedAuditsGroupTitle")]
pub passed_audits_group_title: Option<String>,
/// Descriptive explanation for emulation setting when emulating a generic desktop form factor, as opposed to a mobile-device like form factor.
#[serde(rename="runtimeDesktopEmulation")]
pub runtime_desktop_emulation: Option<String>,
/// Descriptive explanation for emulation setting when emulating a Nexus 5X mobile device.
#[serde(rename="runtimeMobileEmulation")]
pub runtime_mobile_emulation: Option<String>,
/// Descriptive explanation for emulation setting when no device emulation is set.
#[serde(rename="runtimeNoEmulation")]
pub runtime_no_emulation: Option<String>,
/// Label for a row in a table that shows the version of the Axe library used
#[serde(rename="runtimeSettingsAxeVersion")]
pub runtime_settings_axe_version: Option<String>,
/// Label for a row in a table that shows the estimated CPU power of the machine running Lighthouse. Example row values: 532, 1492, 783.
#[serde(rename="runtimeSettingsBenchmark")]
pub runtime_settings_benchmark: Option<String>,
/// Label for a row in a table that describes the CPU throttling conditions that were used during a Lighthouse run, if any.
#[serde(rename="runtimeSettingsCPUThrottling")]
pub runtime_settings_cpu_throttling: Option<String>,
/// Label for a row in a table that shows in what tool Lighthouse is being run (e.g. The lighthouse CLI, Chrome DevTools, Lightrider, WebPageTest, etc).
#[serde(rename="runtimeSettingsChannel")]
pub runtime_settings_channel: Option<String>,
/// Label for a row in a table that describes the kind of device that was emulated for the Lighthouse run. Example values for row elements: 'No Emulation', 'Emulated Desktop', etc.
#[serde(rename="runtimeSettingsDevice")]
pub runtime_settings_device: Option<String>,
/// Label for a row in a table that shows the time at which a Lighthouse run was conducted; formatted as a timestamp, e.g. Jan 1, 1970 12:00 AM UTC.
#[serde(rename="runtimeSettingsFetchTime")]
pub runtime_settings_fetch_time: Option<String>,
/// Label for a row in a table that describes the network throttling conditions that were used during a Lighthouse run, if any.
#[serde(rename="runtimeSettingsNetworkThrottling")]
pub runtime_settings_network_throttling: Option<String>,
/// Title of the Runtime settings table in a Lighthouse report. Runtime settings are the environment configurations that a specific report used at auditing time.
#[serde(rename="runtimeSettingsTitle")]
pub runtime_settings_title: Option<String>,
/// Label for a row in a table that shows the User Agent that was detected on the Host machine that ran Lighthouse.
#[serde(rename="runtimeSettingsUA")]
pub runtime_settings_ua: Option<String>,
/// Label for a row in a table that shows the User Agent that was used to send out all network requests during the Lighthouse run.
#[serde(rename="runtimeSettingsUANetwork")]
pub runtime_settings_ua_network: Option<String>,
/// Label for a row in a table that shows the URL that was audited during a Lighthouse run.
#[serde(rename="runtimeSettingsUrl")]
pub runtime_settings_url: Option<String>,
/// Descriptive explanation for a runtime setting that is set to an unknown value.
#[serde(rename="runtimeUnknown")]
pub runtime_unknown: Option<String>,
/// The label that explains the score gauges scale (0-49, 50-89, 90-100).
#[serde(rename="scorescaleLabel")]
pub scorescale_label: Option<String>,
/// Label preceding a radio control for filtering the list of audits. The radio choices are various performance metrics (FCP, LCP, TBT), and if chosen, the audits in the report are hidden if they are not relevant to the selected metric.
#[serde(rename="showRelevantAudits")]
pub show_relevant_audits: Option<String>,
/// The label for the button to show only a few lines of a snippet
#[serde(rename="snippetCollapseButtonLabel")]
pub snippet_collapse_button_label: Option<String>,
/// The label for the button to show all lines of a snippet
#[serde(rename="snippetExpandButtonLabel")]
pub snippet_expand_button_label: Option<String>,
/// This label is for a filter checkbox above a table of items
#[serde(rename="thirdPartyResourcesLabel")]
pub third_party_resources_label: Option<String>,
/// Descriptive explanation for environment throttling that was provided by the runtime environment instead of provided by Lighthouse throttling.
#[serde(rename="throttlingProvided")]
pub throttling_provided: Option<String>,
/// The label shown preceding important warnings that may have invalidated an entire report.
#[serde(rename="toplevelWarningsMessage")]
pub toplevel_warnings_message: Option<String>,
/// The disclaimer shown below a performance metric value.
#[serde(rename="varianceDisclaimer")]
pub variance_disclaimer: Option<String>,
/// Label for a button that opens the Treemap App
#[serde(rename="viewTreemapLabel")]
pub view_treemap_label: Option<String>,
/// The heading that is shown above a list of audits that have warnings
#[serde(rename="warningAuditsGroupTitle")]
pub warning_audits_group_title: Option<String>,
/// The label shown above a bulleted list of warnings.
#[serde(rename="warningHeader")]
pub warning_header: Option<String>,
}
impl client::Part for RendererFormattedStrings {}
/// Message containing a runtime error config.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct RuntimeError {
/// The enumerated Lighthouse Error code.
pub code: Option<String>,
/// A human readable message explaining the error code.
pub message: Option<String>,
}
impl client::Part for RuntimeError {}
/// Message containing Stack Pack information.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct StackPack {
/// The stack pack advice strings.
pub descriptions: Option<HashMap<String, String>>,
/// The stack pack icon data uri.
#[serde(rename="iconDataURL")]
pub icon_data_url: Option<String>,
/// The stack pack id.
pub id: Option<String>,
/// The stack pack title.
pub title: Option<String>,
}
impl client::Part for StackPack {}
/// Message containing the performance timing data for the Lighthouse run.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct Timing {
/// The total duration of Lighthouse's run.
pub total: Option<f64>,
}
impl client::Part for Timing {}
/// A CrUX metric object for a single metric and form factor.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct UserPageLoadMetricV5 {
/// The category of the specific time metric.
pub category: Option<String>,
/// Metric distributions. Proportions should sum up to 1.
pub distributions: Option<Vec<Bucket>>,
/// Identifies the form factor of the metric being collected.
#[serde(rename="formFactor")]
pub form_factor: Option<String>,
/// The median number of the metric, in millisecond.
pub median: Option<i32>,
/// Identifies the type of the metric.
#[serde(rename="metricId")]
pub metric_id: Option<String>,
/// We use this field to store certain percentile value for this metric. For v4, this field contains pc50. For v5, this field contains pc90.
pub percentile: Option<i32>,
}
impl client::Part for UserPageLoadMetricV5 {}
// ###################
// MethodBuilders ###
// #################
/// A builder providing access to all methods supported on *pagespeedapi* resources.
/// It is not used directly, but through the [`PagespeedInsights`] hub.
///
/// # Example
///
/// Instantiate a resource builder
///
/// ```test_harness,no_run
/// extern crate hyper;
/// extern crate hyper_rustls;
/// extern crate google_pagespeedonline5 as pagespeedonline5;
///
/// # async fn dox() {
/// use std::default::Default;
/// use pagespeedonline5::{PagespeedInsights, oauth2, hyper, hyper_rustls, chrono, FieldMask};
///
/// let secret: oauth2::ApplicationSecret = Default::default();
/// let auth = oauth2::InstalledFlowAuthenticator::builder(
/// secret,
/// oauth2::InstalledFlowReturnMethod::HTTPRedirect,
/// ).build().await.unwrap();
/// let mut hub = PagespeedInsights::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
/// // Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
/// // like `runpagespeed(...)`
/// // to build up your call.
/// let rb = hub.pagespeedapi();
/// # }
/// ```
pub struct PagespeedapiMethods<'a, S>
where S: 'a {
hub: &'a PagespeedInsights<S>,
}
impl<'a, S> client::MethodsBuilder for PagespeedapiMethods<'a, S> {}
impl<'a, S> PagespeedapiMethods<'a, S> {
/// Create a builder to help you perform the following task:
///
/// 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.
///
/// # Arguments
///
/// * `url` - Required. The URL to fetch and analyze
pub fn runpagespeed(&self, url: &str) -> PagespeedapiRunpagespeedCall<'a, S> {
PagespeedapiRunpagespeedCall {
hub: self.hub,
_url: url.to_string(),
_utm_source: Default::default(),
_utm_campaign: Default::default(),
_strategy: Default::default(),
_locale: Default::default(),
_category: Default::default(),
_captcha_token: Default::default(),
_delegate: Default::default(),
_additional_params: Default::default(),
_scopes: Default::default(),
}
}
}
// ###################
// CallBuilders ###
// #################
/// 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.
///
/// A builder for the *runpagespeed* method supported by a *pagespeedapi* resource.
/// It is not used directly, but through a [`PagespeedapiMethods`] instance.
///
/// # Example
///
/// Instantiate a resource method builder
///
/// ```test_harness,no_run
/// # extern crate hyper;
/// # extern crate hyper_rustls;
/// # extern crate google_pagespeedonline5 as pagespeedonline5;
/// # async fn dox() {
/// # use std::default::Default;
/// # use pagespeedonline5::{PagespeedInsights, oauth2, hyper, hyper_rustls, chrono, FieldMask};
///
/// # let secret: oauth2::ApplicationSecret = Default::default();
/// # let auth = oauth2::InstalledFlowAuthenticator::builder(
/// # secret,
/// # oauth2::InstalledFlowReturnMethod::HTTPRedirect,
/// # ).build().await.unwrap();
/// # let mut hub = PagespeedInsights::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
/// // You can configure optional parameters by calling the respective setters at will, and
/// // execute the final call using `doit()`.
/// // Values shown here are possibly random and not representative !
/// let result = hub.pagespeedapi().runpagespeed("url")
/// .utm_source("duo")
/// .utm_campaign("ipsum")
/// .strategy("sed")
/// .locale("ut")
/// .add_category("gubergren")
/// .captcha_token("rebum.")
/// .doit().await;
/// # }
/// ```
pub struct PagespeedapiRunpagespeedCall<'a, S>
where S: 'a {
hub: &'a PagespeedInsights<S>,
_url: String,
_utm_source: Option<String>,
_utm_campaign: Option<String>,
_strategy: Option<String>,
_locale: Option<String>,
_category: Vec<String>,
_captcha_token: Option<String>,
_delegate: Option<&'a mut dyn client::Delegate>,
_additional_params: HashMap<String, String>,
_scopes: BTreeSet<String>
}
impl<'a, S> client::CallBuilder for PagespeedapiRunpagespeedCall<'a, S> {}
impl<'a, S> PagespeedapiRunpagespeedCall<'a, S>
where
S: tower_service::Service<http::Uri> + Clone + Send + Sync + 'static,
S::Response: hyper::client::connect::Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static,
S::Future: Send + Unpin + 'static,
S::Error: Into<Box<dyn StdError + Send + Sync>>,
{
/// Perform the operation you have build so far.
pub async fn doit(mut self) -> client::Result<(hyper::Response<hyper::body::Body>, PagespeedApiPagespeedResponseV5)> {
use std::io::{Read, Seek};
use hyper::header::{CONTENT_TYPE, CONTENT_LENGTH, AUTHORIZATION, USER_AGENT, LOCATION};
use client::{ToParts, url::Params};
use std::borrow::Cow;
let mut dd = client::DefaultDelegate;
let mut dlg: &mut dyn client::Delegate = self._delegate.unwrap_or(&mut dd);
dlg.begin(client::MethodInfo { id: "pagespeedonline.pagespeedapi.runpagespeed",
http_method: hyper::Method::GET });
for &field in ["alt", "url", "utm_source", "utm_campaign", "strategy", "locale", "category", "captchaToken"].iter() {
if self._additional_params.contains_key(field) {
dlg.finished(false);
return Err(client::Error::FieldClash(field));
}
}
let mut params = Params::with_capacity(9 + self._additional_params.len());
params.push("url", self._url);
if let Some(value) = self._utm_source.as_ref() {
params.push("utm_source", value);
}
if let Some(value) = self._utm_campaign.as_ref() {
params.push("utm_campaign", value);
}
if let Some(value) = self._strategy.as_ref() {
params.push("strategy", value);
}
if let Some(value) = self._locale.as_ref() {
params.push("locale", value);
}
if self._category.len() > 0 {
for f in self._category.iter() {
params.push("category", f);
}
}
if let Some(value) = self._captcha_token.as_ref() {
params.push("captchaToken", value);
}
params.extend(self._additional_params.iter());
params.push("alt", "json");
let mut url = self.hub._base_url.clone() + "pagespeedonline/v5/runPagespeed";
if self._scopes.is_empty() {
self._scopes.insert(Scope::Openid.as_ref().to_string());
}
let url = params.parse_with_url(&url);
loop {
let token = match self.hub.auth.get_token(&self._scopes.iter().map(String::as_str).collect::<Vec<_>>()[..]).await {
Ok(token) => token,
Err(e) => {
match dlg.token(e) {
Ok(token) => token,
Err(e) => {
dlg.finished(false);
return Err(client::Error::MissingToken(e));
}
}
}
};
let mut req_result = {
let client = &self.hub.client;
dlg.pre_request();
let mut req_builder = hyper::Request::builder()
.method(hyper::Method::GET)
.uri(url.as_str())
.header(USER_AGENT, self.hub._user_agent.clone());
if let Some(token) = token.as_ref() {
req_builder = req_builder.header(AUTHORIZATION, format!("Bearer {}", token));
}
let request = req_builder
.body(hyper::body::Body::empty());
client.request(request.unwrap()).await
};
match req_result {
Err(err) => {
if let client::Retry::After(d) = dlg.http_error(&err) {
sleep(d).await;
continue;
}
dlg.finished(false);
return Err(client::Error::HttpError(err))
}
Ok(mut res) => {
if !res.status().is_success() {
let res_body_string = client::get_body_as_string(res.body_mut()).await;
let (parts, _) = res.into_parts();
let body = hyper::Body::from(res_body_string.clone());
let restored_response = hyper::Response::from_parts(parts, body);
let server_response = json::from_str::<serde_json::Value>(&res_body_string).ok();
if let client::Retry::After(d) = dlg.http_failure(&restored_response, server_response.clone()) {
sleep(d).await;
continue;
}
dlg.finished(false);
return match server_response {
Some(error_value) => Err(client::Error::BadRequest(error_value)),
None => Err(client::Error::Failure(restored_response)),
}
}
let result_value = {
let res_body_string = client::get_body_as_string(res.body_mut()).await;
match json::from_str(&res_body_string) {
Ok(decoded) => (res, decoded),
Err(err) => {
dlg.response_json_decode_error(&res_body_string, &err);
return Err(client::Error::JsonDecodeError(res_body_string, err));
}
}
};
dlg.finished(true);
return Ok(result_value)
}
}
}
}
/// Required. The URL to fetch and analyze
///
/// Sets the *url* query property to the given value.
///
/// Even though the property as already been set when instantiating this call,
/// we provide this method for API completeness.
pub fn url(mut self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a, S> {
self._url = new_value.to_string();
self
}
/// Campaign source for analytics.
///
/// Sets the *utm_source* query property to the given value.
pub fn utm_source(mut self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a, S> {
self._utm_source = Some(new_value.to_string());
self
}
/// Campaign name for analytics.
///
/// Sets the *utm_campaign* query property to the given value.
pub fn utm_campaign(mut self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a, S> {
self._utm_campaign = Some(new_value.to_string());
self
}
/// The analysis strategy (desktop or mobile) to use, and desktop is the default
///
/// Sets the *strategy* query property to the given value.
pub fn strategy(mut self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a, S> {
self._strategy = Some(new_value.to_string());
self
}
/// The locale used to localize formatted results
///
/// Sets the *locale* query property to the given value.
pub fn locale(mut self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a, S> {
self._locale = Some(new_value.to_string());
self
}
/// A Lighthouse category to run; if none are given, only Performance category will be run
///
/// Append the given value to the *category* query property.
/// Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.
pub fn add_category(mut self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a, S> {
self._category.push(new_value.to_string());
self
}
/// The captcha token passed when filling out a captcha.
///
/// Sets the *captcha token* query property to the given value.
pub fn captcha_token(mut self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a, S> {
self._captcha_token = Some(new_value.to_string());
self
}
/// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong
/// while executing the actual API request.
///
/// ````text
/// It should be used to handle progress information, and to implement a certain level of resilience.
/// ````
///
/// Sets the *delegate* property to the given value.
pub fn delegate(mut self, new_value: &'a mut dyn client::Delegate) -> PagespeedapiRunpagespeedCall<'a, S> {
self._delegate = Some(new_value);
self
}
/// Set any additional parameter of the query string used in the request.
/// It should be used to set parameters which are not yet available through their own
/// setters.
///
/// Please note that this method must not be used to set any of the known parameters
/// which have their own setter method. If done anyway, the request will fail.
///
/// # Additional Parameters
///
/// * *$.xgafv* (query-string) - V1 error format.
/// * *access_token* (query-string) - OAuth access token.
/// * *alt* (query-string) - Data format for response.
/// * *callback* (query-string) - JSONP
/// * *fields* (query-string) - Selector specifying which fields to include in a partial response.
/// * *key* (query-string) - 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.
/// * *oauth_token* (query-string) - OAuth 2.0 token for the current user.
/// * *prettyPrint* (query-boolean) - Returns response with indentations and line breaks.
/// * *quotaUser* (query-string) - 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.
/// * *uploadType* (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
/// * *upload_protocol* (query-string) - Upload protocol for media (e.g. "raw", "multipart").
pub fn param<T>(mut self, name: T, value: T) -> PagespeedapiRunpagespeedCall<'a, S>
where T: AsRef<str> {
self._additional_params.insert(name.as_ref().to_string(), value.as_ref().to_string());
self
}
/// Identifies the authorization scope for the method you are building.
///
/// Use this method to actively specify which scope should be used, instead of the default [`Scope`] variant
/// [`Scope::Openid`].
///
/// The `scope` will be added to a set of scopes. This is important as one can maintain access
/// tokens for more than one scope.
///
/// Usually there is more than one suitable scope to authorize an operation, some of which may
/// encompass more rights than others. For example, for listing resources, a *read-only* scope will be
/// sufficient, a read-write scope will do as well.
pub fn add_scope<St>(mut self, scope: St) -> PagespeedapiRunpagespeedCall<'a, S>
where St: AsRef<str> {
self._scopes.insert(String::from(scope.as_ref()));
self
}
/// Identifies the authorization scope(s) for the method you are building.
///
/// See [`Self::add_scope()`] for details.
pub fn add_scopes<I, St>(mut self, scopes: I) -> PagespeedapiRunpagespeedCall<'a, S>
where I: IntoIterator<Item = St>,
St: AsRef<str> {
self._scopes
.extend(scopes.into_iter().map(|s| String::from(s.as_ref())));
self
}
/// Removes all scopes, and no default scope will be used either.
/// In this case, you have to specify your API-key using the `key` parameter (see [`Self::param()`]
/// for details).
pub fn clear_scopes(mut self) -> PagespeedapiRunpagespeedCall<'a, S> {
self._scopes.clear();
self
}
}