com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1PageInfo

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1PageInfo

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1PageInfo
extends com.google.api.client.json.GenericJson

Detailed page information.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1PageInfo()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1PageInfo	clone()
String	getPageCategory() The most specific category associated with a category page.
String	getPageviewId() A unique ID of a web page view.
String	getReferrerUri() The referrer URL of the current page.
String	getUri() Complete URL (window.location.href) of the user's current page.
GoogleCloudDiscoveryengineV1PageInfo	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1PageInfo	setPageCategory(String pageCategory) The most specific category associated with a category page.
GoogleCloudDiscoveryengineV1PageInfo	setPageviewId(String pageviewId) A unique ID of a web page view.
GoogleCloudDiscoveryengineV1PageInfo	setReferrerUri(String referrerUri) The referrer URL of the current page.
GoogleCloudDiscoveryengineV1PageInfo	setUri(String uri) Complete URL (window.location.href) of the user's current page.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1PageInfo

public GoogleCloudDiscoveryengineV1PageInfo()

Method Detail

getPageCategory

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

Returns:

value or null for none

setPageCategory

public GoogleCloudDiscoveryengineV1PageInfo setPageCategory(String pageCategory)

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.

Parameters:

pageCategory - pageCategory or null for none

getPageviewId

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

Returns:

value or null for none

setPageviewId

public GoogleCloudDiscoveryengineV1PageInfo setPageviewId(String pageviewId)

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.

Parameters:

pageviewId - pageviewId or null for none

getReferrerUri

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

Returns:

value or null for none

setReferrerUri

public GoogleCloudDiscoveryengineV1PageInfo setReferrerUri(String referrerUri)

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.

Parameters:

referrerUri - referrerUri or null for none

getUri

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

Returns:

value or null for none

setUri

public GoogleCloudDiscoveryengineV1PageInfo setUri(String uri)

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.

Parameters:

uri - uri or null for none

set

public GoogleCloudDiscoveryengineV1PageInfo set(String fieldName,
                                                Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1PageInfo clone()

Overrides:

clone in class com.google.api.client.json.GenericJson