Discovery Engine v1 API - Class PageInfo (1.0.0-beta03) 

public sealed class PageInfo : IMessage<PageInfo>, IEquatable<PageInfo>, IDeepCloneable<PageInfo>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class PageInfo.

Detailed page information.

Inheritance

object > PageInfo

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

PageInfo()

public PageInfo()

PageInfo(PageInfo)

public PageInfo(PageInfo other)
Parameter
NameDescription
otherPageInfo

Properties

PageCategory

public string PageCategory { get; set; }

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, please 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.

Property Value
TypeDescription
string

PageviewId

public string PageviewId { get; set; }

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.

Property Value
TypeDescription
string

ReferrerUri

public string ReferrerUri { get; set; }

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.

Property Value
TypeDescription
string

Uri

public string Uri { get; set; }

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.

Property Value
TypeDescription
string