Class PageInfo (0.41.0)

public final class PageInfo extends GeneratedMessageV3 implements PageInfoOrBuilder

Detailed page information.

Protobuf type google.cloud.discoveryengine.v1.PageInfo

Implements

PageInfoOrBuilder

Static Fields

PAGEVIEW_ID_FIELD_NUMBER

public static final int PAGEVIEW_ID_FIELD_NUMBER
Field Value
Type Description
int

PAGE_CATEGORY_FIELD_NUMBER

public static final int PAGE_CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

REFERRER_URI_FIELD_NUMBER

public static final int REFERRER_URI_FIELD_NUMBER
Field Value
Type Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PageInfo getDefaultInstance()
Returns
Type Description
PageInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PageInfo.Builder newBuilder()
Returns
Type Description
PageInfo.Builder

newBuilder(PageInfo prototype)

public static PageInfo.Builder newBuilder(PageInfo prototype)
Parameter
Name Description
prototype PageInfo
Returns
Type Description
PageInfo.Builder

parseDelimitedFrom(InputStream input)

public static PageInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PageInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PageInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PageInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PageInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PageInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PageInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PageInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PageInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PageInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PageInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PageInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PageInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PageInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PageInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PageInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PageInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PageInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PageInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PageInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PageInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PageInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PageInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PageInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PageInfo> parser()
Returns
Type Description
Parser<PageInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PageInfo getDefaultInstanceForType()
Returns
Type Description
PageInfo

getPageCategory()

public String getPageCategory()

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.

string page_category = 2;

Returns
Type Description
String

The pageCategory.

getPageCategoryBytes()

public ByteString getPageCategoryBytes()

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.

string page_category = 2;

Returns
Type Description
ByteString

The bytes for pageCategory.

getPageviewId()

public String getPageviewId()

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.

string pageview_id = 1;

Returns
Type Description
String

The pageviewId.

getPageviewIdBytes()

public ByteString getPageviewIdBytes()

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.

string pageview_id = 1;

Returns
Type Description
ByteString

The bytes for pageviewId.

getParserForType()

public Parser<PageInfo> getParserForType()
Returns
Type Description
Parser<PageInfo>
Overrides

getReferrerUri()

public String getReferrerUri()

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.

string referrer_uri = 4;

Returns
Type Description
String

The referrerUri.

getReferrerUriBytes()

public ByteString getReferrerUriBytes()

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.

string referrer_uri = 4;

Returns
Type Description
ByteString

The bytes for referrerUri.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUri()

public String getUri()

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.

string uri = 3;

Returns
Type Description
String

The uri.

getUriBytes()

public ByteString getUriBytes()

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.

string uri = 3;

Returns
Type Description
ByteString

The bytes for uri.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PageInfo.Builder newBuilderForType()
Returns
Type Description
PageInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PageInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PageInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PageInfo.Builder toBuilder()
Returns
Type Description
PageInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException