Package com.google.cloud.discoveryengine.v1beta

Class PageInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.PageInfo
All Implemented Interfaces:
PageInfoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PageInfo extends com.google.protobuf.GeneratedMessage implements PageInfoOrBuilder
 Detailed page information.
Protobuf type google.cloud.discoveryengine.v1beta.PageInfo
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    PageInfo.Builder
    Detailed page information.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    PAGE_CATEGORY_FIELD_NUMBER
     
    static final int
    PAGEVIEW_ID_FIELD_NUMBER
     
    static final int
    REFERRER_URI_FIELD_NUMBER
     
    static final int
    URI_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static PageInfo
    getDefaultInstance()
     
    PageInfo
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getPageCategory()
    The most specific category associated with a category page.
    com.google.protobuf.ByteString
    getPageCategoryBytes()
    The most specific category associated with a category page.
    String
    getPageviewId()
    A unique ID of a web page view.
    com.google.protobuf.ByteString
    getPageviewIdBytes()
    A unique ID of a web page view.
    com.google.protobuf.Parser<PageInfo>
    getParserForType()
     
    String
    getReferrerUri()
    The referrer URL of the current page.
    com.google.protobuf.ByteString
    getReferrerUriBytes()
    The referrer URL of the current page.
    int
    getSerializedSize()
     
    String
    getUri()
    Complete URL (window.location.href) of the user's current page.
    com.google.protobuf.ByteString
    getUriBytes()
    Complete URL (window.location.href) of the user's current page.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static PageInfo.Builder
    newBuilder()
     
    static PageInfo.Builder
    newBuilder(PageInfo prototype)
     
    PageInfo.Builder
    newBuilderForType()
     
    protected PageInfo.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static PageInfo
    parseDelimitedFrom(InputStream input)
     
    static PageInfo
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PageInfo
    parseFrom(byte[] data)
     
    static PageInfo
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PageInfo
    parseFrom(com.google.protobuf.ByteString data)
     
    static PageInfo
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PageInfo
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PageInfo
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PageInfo
    parseFrom(InputStream input)
     
    static PageInfo
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PageInfo
    parseFrom(ByteBuffer data)
     
    static PageInfo
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PageInfo>
    parser()
     
    PageInfo.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • PAGEVIEW_ID_FIELD_NUMBER

      public static final int PAGEVIEW_ID_FIELD_NUMBER
      See Also:

    • PAGE_CATEGORY_FIELD_NUMBER

      public static final int PAGE_CATEGORY_FIELD_NUMBER
      See Also:

    • URI_FIELD_NUMBER

      public static final int URI_FIELD_NUMBER
      See Also:

    • REFERRER_URI_FIELD_NUMBER

      public static final int REFERRER_URI_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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;
      Specified by:
      getPageviewId in interface PageInfoOrBuilder
      Returns:
      The pageviewId.

    • getPageviewIdBytes

      public com.google.protobuf.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;
      Specified by:
      getPageviewIdBytes in interface PageInfoOrBuilder
      Returns:
      The bytes for pageviewId.

    • 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;
      Specified by:
      getPageCategory in interface PageInfoOrBuilder
      Returns:
      The pageCategory.

    • getPageCategoryBytes

      public com.google.protobuf.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;
      Specified by:
      getPageCategoryBytes in interface PageInfoOrBuilder
      Returns:
      The bytes for pageCategory.

    • 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;
      Specified by:
      getUri in interface PageInfoOrBuilder
      Returns:
      The uri.

    • getUriBytes

      public com.google.protobuf.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;
      Specified by:
      getUriBytes in interface PageInfoOrBuilder
      Returns:
      The bytes for uri.

    • 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;
      Specified by:
      getReferrerUri in interface PageInfoOrBuilder
      Returns:
      The referrerUri.

    • getReferrerUriBytes

      public com.google.protobuf.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;
      Specified by:
      getReferrerUriBytes in interface PageInfoOrBuilder
      Returns:
      The bytes for referrerUri.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static PageInfo parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PageInfo parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PageInfo parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PageInfo parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PageInfo parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PageInfo parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PageInfo parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PageInfo parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PageInfo parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PageInfo parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PageInfo parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PageInfo parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public PageInfo.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static PageInfo.Builder newBuilder()

    • newBuilder

      public static PageInfo.Builder newBuilder(PageInfo prototype)

    • toBuilder

      public PageInfo.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected PageInfo.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static PageInfo getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PageInfo> parser()

    • getParserForType

      public com.google.protobuf.Parser<PageInfo> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public PageInfo getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder