Class: Google::Cloud::DiscoveryEngine::V1::PageInfo

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/user_event.rb

Overview

Detailed page information.

Instance Attribute Summary collapse

Instance Attribute Details

#page_category ⇒ ::String

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

Returns:

  • (::String) —

    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.



276
277
278
279
 
# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 276

class PageInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#pageview_id ⇒ ::String

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

Returns:

  • (::String) —

    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.



276
277
278
279
 
# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 276

class PageInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#referrer_uri ⇒ ::String

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

Returns:

  • (::String) —

    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.



276
277
278
279
 
# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 276

class PageInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#uri ⇒ ::String

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

Returns:

  • (::String) —

    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.



276
277
278
279
 
# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 276

class PageInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end