Package com.google.cloud.discoveryengine.v1beta

Interface PageInfoOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PageInfo, PageInfo.Builder
@Generated public interface PageInfoOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    String
    getReferrerUri()
    The referrer URL of the current page.
    com.google.protobuf.ByteString
    getReferrerUriBytes()
    The referrer URL of the current page.
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getPageviewId

      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:
      The pageviewId.

    • getPageviewIdBytes

      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;
      Returns:
      The bytes for pageviewId.

    • getPageCategory

      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:
      The pageCategory.

    • getPageCategoryBytes

      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;
      Returns:
      The bytes for pageCategory.

    • getUri

      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:
      The uri.

    • getUriBytes

      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;
      Returns:
      The bytes for uri.

    • getReferrerUri

      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:
      The referrerUri.

    • getReferrerUriBytes

      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;
      Returns:
      The bytes for referrerUri.