Class PageInfo.Builder (0.37.0)

public static final class PageInfo.Builder extends GeneratedMessageV3.Builder<PageInfo.Builder> implements PageInfoOrBuilder

Detailed page information.

Protobuf type google.cloud.discoveryengine.v1.PageInfo

Implements

PageInfoOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PageInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PageInfo.Builder
Overrides

build()

public PageInfo build()
Returns
TypeDescription
PageInfo

buildPartial()

public PageInfo buildPartial()
Returns
TypeDescription
PageInfo

clear()

public PageInfo.Builder clear()
Returns
TypeDescription
PageInfo.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public PageInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PageInfo.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public PageInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PageInfo.Builder
Overrides

clearPageCategory()

public PageInfo.Builder clearPageCategory()

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.

string page_category = 2;

Returns
TypeDescription
PageInfo.Builder

This builder for chaining.

clearPageviewId()

public PageInfo.Builder clearPageviewId()

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
TypeDescription
PageInfo.Builder

This builder for chaining.

clearReferrerUri()

public PageInfo.Builder clearReferrerUri()

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
TypeDescription
PageInfo.Builder

This builder for chaining.

clearUri()

public PageInfo.Builder clearUri()

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
TypeDescription
PageInfo.Builder

This builder for chaining.

clone()

public PageInfo.Builder clone()
Returns
TypeDescription
PageInfo.Builder
Overrides

getDefaultInstanceForType()

public PageInfo getDefaultInstanceForType()
Returns
TypeDescription
PageInfo

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

string page_category = 2;

Returns
TypeDescription
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, 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.

string page_category = 2;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for pageviewId.

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
TypeDescription
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
TypeDescription
ByteString

The bytes for referrerUri.

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
TypeDescription
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
TypeDescription
ByteString

The bytes for uri.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(PageInfo other)

public PageInfo.Builder mergeFrom(PageInfo other)
Parameter
NameDescription
otherPageInfo
Returns
TypeDescription
PageInfo.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PageInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PageInfo.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PageInfo.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PageInfo.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PageInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PageInfo.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public PageInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PageInfo.Builder
Overrides

setPageCategory(String value)

public PageInfo.Builder setPageCategory(String value)

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.

string page_category = 2;

Parameter
NameDescription
valueString

The pageCategory to set.

Returns
TypeDescription
PageInfo.Builder

This builder for chaining.

setPageCategoryBytes(ByteString value)

public PageInfo.Builder setPageCategoryBytes(ByteString value)

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.

string page_category = 2;

Parameter
NameDescription
valueByteString

The bytes for pageCategory to set.

Returns
TypeDescription
PageInfo.Builder

This builder for chaining.

setPageviewId(String value)

public PageInfo.Builder setPageviewId(String value)

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;

Parameter
NameDescription
valueString

The pageviewId to set.

Returns
TypeDescription
PageInfo.Builder

This builder for chaining.

setPageviewIdBytes(ByteString value)

public PageInfo.Builder setPageviewIdBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for pageviewId to set.

Returns
TypeDescription
PageInfo.Builder

This builder for chaining.

setReferrerUri(String value)

public PageInfo.Builder setReferrerUri(String value)

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;

Parameter
NameDescription
valueString

The referrerUri to set.

Returns
TypeDescription
PageInfo.Builder

This builder for chaining.

setReferrerUriBytes(ByteString value)

public PageInfo.Builder setReferrerUriBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for referrerUri to set.

Returns
TypeDescription
PageInfo.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PageInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PageInfo.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PageInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PageInfo.Builder
Overrides

setUri(String value)

public PageInfo.Builder setUri(String value)

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;

Parameter
NameDescription
valueString

The uri to set.

Returns
TypeDescription
PageInfo.Builder

This builder for chaining.

setUriBytes(ByteString value)

public PageInfo.Builder setUriBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for uri to set.

Returns
TypeDescription
PageInfo.Builder

This builder for chaining.