public final class PageInfo extends GeneratedMessageV3 implements PageInfoOrBuilder
Detailed page information.
Protobuf type google.cloud.discoveryengine.v1beta.PageInfo
Static Fields
PAGEVIEW_ID_FIELD_NUMBER
public static final int PAGEVIEW_ID_FIELD_NUMBER
Field Value
PAGE_CATEGORY_FIELD_NUMBER
public static final int PAGE_CATEGORY_FIELD_NUMBER
Field Value
REFERRER_URI_FIELD_NUMBER
public static final int REFERRER_URI_FIELD_NUMBER
Field Value
URI_FIELD_NUMBER
public static final int URI_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static PageInfo getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static PageInfo.Builder newBuilder()
Returns
newBuilder(PageInfo prototype)
public static PageInfo.Builder newBuilder(PageInfo prototype)
Parameter
Returns
parseDelimitedFrom(InputStream input)
public static PageInfo parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PageInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PageInfo parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PageInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PageInfo parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PageInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static PageInfo parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PageInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static PageInfo parseFrom(InputStream input)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PageInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PageInfo parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PageInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<PageInfo> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public PageInfo getDefaultInstanceForType()
Returns
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;
| 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, 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;
| 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 pageViewId 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;
| 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 pageViewId 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;
| Type | Description |
ByteString | The bytes for pageviewId.
|
getParserForType()
public Parser<PageInfo> getParserForType()
Returns
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;
| 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;
| Type | Description |
ByteString | The bytes for referrerUri.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
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;
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public PageInfo.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PageInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public PageInfo.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
