Struct PageInfo 

#[non_exhaustive]
pub struct PageInfo {
    pub pageview_id: String,
    pub page_category: String,
    pub uri: String,
    pub referrer_uri: String,
    /* private fields */
}

Available on crate features recommendation-service or user-event-service only.

Detailed page information.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pageview_id: String

A unique ID of a web page view.

This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The pageview_id property should be kept the same for all these events so that they can be grouped together properly.

When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.

page_category: String

The most specific category associated with a category page.

To represent full path of category, use ‘>’ sign to separate different hierarchies. If ‘>’ is part of the category name, replace it with other character(s).

Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategory" : "Sales > 2017 Black Friday Deals".

Required for view-category-page events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

uri: String

Complete URL (window.location.href) of the user’s current page.

When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters.

referrer_uri: String

The referrer URL of the current page.

When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. However, some browser privacy restrictions may cause this field to be empty.

Implementations

impl PageInfo

pub fn new() -> Self

pub fn set_pageview_id<T: Into<String>>(self, v: T) -> Self

Sets the value of pageview_id.

Example

let x = PageInfo::new().set_pageview_id("example");

pub fn set_page_category<T: Into<String>>(self, v: T) -> Self

Sets the value of page_category.

Example

let x = PageInfo::new().set_page_category("example");

pub fn set_uri<T: Into<String>>(self, v: T) -> Self

Sets the value of uri.

Example

let x = PageInfo::new().set_uri("example");

pub fn set_referrer_uri<T: Into<String>>(self, v: T) -> Self

Sets the value of referrer_uri.

Example

let x = PageInfo::new().set_referrer_uri("example");

Trait Implementations

impl Clone for PageInfo

fn clone(&self) -> PageInfo

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PageInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PageInfo

fn default() -> PageInfo

Returns the “default value” for a type.

impl Message for PageInfo

fn typename() -> &'static str

The typename of this message.

impl PartialEq for PageInfo

fn eq(&self, other: &PageInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PageInfo