com.google.api.services.content.model

Class Segments

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.content.model.Segments

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Segments
extends GenericJson

Dimensions according to which metrics are segmented in the response. Values of product dimensions, e.g., offer id, reflect the state of a product at the time of the corresponding event, e.g., impression or order. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for dimensions requested explicitly in the request's search query.

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 Content API for Shopping. 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

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
Segments()

Method Summary

Modifier and Type	Method and Description
Segments	clone()
Date	getDate() Date in the merchant timezone to which metrics apply.
String	getOfferId() Merchant-provided id of the product.
String	getProgram() Program to which metrics apply, e.g., Free Product Listing.
Segments	set(String fieldName, Object value)
Segments	setDate(Date date) Date in the merchant timezone to which metrics apply.
Segments	setOfferId(String offerId) Merchant-provided id of the product.
Segments	setProgram(String program) Program to which metrics apply, e.g., Free Product Listing.

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

Segments

public Segments()

Method Detail

getDate

public Date getDate()

Date in the merchant timezone to which metrics apply.

Returns:

value or null for none

setDate

public Segments setDate(Date date)

Date in the merchant timezone to which metrics apply.

Parameters:

date - date or null for none

getOfferId

public String getOfferId()

Merchant-provided id of the product.

Returns:

value or null for none

setOfferId

public Segments setOfferId(String offerId)

Merchant-provided id of the product.

Parameters:

offerId - offerId or null for none

getProgram

public String getProgram()

Program to which metrics apply, e.g., Free Product Listing.

Returns:

value or null for none

setProgram

public Segments setProgram(String program)

Program to which metrics apply, e.g., Free Product Listing.

Parameters:

program - program or null for none

set

public Segments set(String fieldName,
                    Object value)

Overrides:

set in class GenericJson

clone

public Segments clone()

Overrides:

clone in class GenericJson