Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPageInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb

Overview

Detailed page information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaPageInfo

Returns a new instance of GoogleCloudDiscoveryengineV1betaPageInfo.



2617
2618
2619
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2617

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, 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. Corresponds to the JSON property pageCategory

Returns:

  • (String) 


2589
2590
2591
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2589

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

Returns:

  • (String) 


2600
2601
2602
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2600

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

Returns:

  • (String) 


2608
2609
2610
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2608

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

Returns:

  • (String) 


2615
2616
2617
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2615

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2622
2623
2624
2625
2626
2627
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2622

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