GoogleApi.ChromeUXReport.V1.Model.QueryHistoryRequest (google_api_chrome_ux_report v0.6.0)

View Source

Request payload sent by a physical web client. This request includes all necessary context to load a particular user experience history record.

Attributes

  • collectionPeriodCount (type: integer(), default: nil) - The number of collection periods to return. If not specified, the default is 25. If present, must be in the range [1, 40].
  • formFactor (type: String.t, default: nil) - The form factor is a query dimension that specifies the device class that the record's data should belong to. Note: If no form factor is specified, then a special record with aggregated data over all form factors will be returned.
  • metrics (type: list(String.t), default: nil) - The metrics that should be included in the response. If none are specified then any metrics found will be returned. Allowed values: ["first_contentful_paint", "first_input_delay", "largest_contentful_paint", "cumulative_layout_shift", "experimental_time_to_first_byte", "experimental_interaction_to_next_paint"]
  • origin (type: String.t, default: nil) - The url pattern "origin" refers to a url pattern that is the origin of a website. Examples: "https://example.com", "https://cloud.google.com"
  • url (type: String.t, default: nil) - The url pattern "url" refers to a url pattern that is any arbitrary url. Examples: "https://example.com/", "https://cloud.google.com/why-google-cloud/"

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ChromeUXReport.V1.Model.QueryHistoryRequest{
  collectionPeriodCount: integer() | nil,
  formFactor: String.t() | nil,
  metrics: [String.t()] | nil,
  origin: String.t() | nil,
  url: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.