Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PageInfo
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PageInfo
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb
Overview
Detailed page information.
Instance Attribute Summary collapse
-
#page_category ⇒ String
The most specific category associated with a category page.
-
#pageview_id ⇒ String
A unique ID of a web page view.
-
#referrer_uri ⇒ String
The referrer URL of the current page.
-
#uri ⇒ String
Complete URL (window.location.href) of the user's current page.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1PageInfo
constructor
A new instance of GoogleCloudDiscoveryengineV1PageInfo.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1PageInfo
Returns a new instance of GoogleCloudDiscoveryengineV1PageInfo.
5047 5048 5049 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5047 def initialize(**args) update!(**args) end |
Instance Attribute Details
#page_category ⇒ 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, 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.
Corresponds to the JSON property pageCategory
5019 5020 5021 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5019 def page_category @page_category end |
#pageview_id ⇒ 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.
Corresponds to the JSON property pageviewId
5030 5031 5032 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5030 def pageview_id @pageview_id end |
#referrer_uri ⇒ 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.
Corresponds to the JSON property referrerUri
5038 5039 5040 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5038 def referrer_uri @referrer_uri end |
#uri ⇒ 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.
Corresponds to the JSON property uri
5045 5046 5047 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5045 def uri @uri end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5052 5053 5054 5055 5056 5057 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5052 def update!(**args) @page_category = args[:page_category] if args.key?(:page_category) @pageview_id = args[:pageview_id] if args.key?(:pageview_id) @referrer_uri = args[:referrer_uri] if args.key?(:referrer_uri) @uri = args[:uri] if args.key?(:uri) end |