Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::PageInfo (v0.1.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::PageInfo.

Detailed page information.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#page_category

def page_category() -> ::String
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.

#page_category=

def page_category=(value) -> ::String
Parameter
  • value (::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.

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.

#pageview_id

def pageview_id() -> ::String
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 pageViewId 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.

#pageview_id=

def pageview_id=(value) -> ::String
Parameter
  • value (::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 pageViewId 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 pageViewId 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.

#referrer_uri

def referrer_uri() -> ::String
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.

#referrer_uri=

def referrer_uri=(value) -> ::String
Parameter
  • value (::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.

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.

#uri

def uri() -> ::String
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.

#uri=

def uri=(value) -> ::String
Parameter
  • value (::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.

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.