target.apidocs.com.google.api.services.content.model.PriceInsights.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-content Show documentation

There is a newer version: v2.1-rev20240825-2.0.0

Show newest version







PriceInsights (Content API for Shopping v2.1-rev20240609-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.content.model
Class PriceInsights



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













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class PriceInsights
extends com.google.api.client.json.GenericJson
Price insights fields requested by the merchant in the query. Field values are only set if the
 merchant queries `PriceInsightsProductView`. https://support.google.com/merchants/answer/11916926

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


PriceInsights() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


PriceInsights
clone() 


String
getEffectiveness()
The predicted effectiveness of applying the price suggestion, bucketed.



Double
getPredictedClicksChangeFraction()
The predicted change in clicks as a fraction after introducing the suggested price compared to
 current active price.



Double
getPredictedConversionsChangeFraction()
The predicted change in conversions as a fraction after introducing the suggested price
 compared to current active price.



Double
getPredictedGrossProfitChangeFraction()
*Deprecated*: This field is no longer supported and will start returning 0.



Double
getPredictedImpressionsChangeFraction()
The predicted change in impressions as a fraction after introducing the suggested price
 compared to current active price.



String
getPredictedMonthlyGrossProfitChangeCurrencyCode()
*Deprecated*: This field is no longer supported and will start returning USD for all requests.



Long
getPredictedMonthlyGrossProfitChangeMicros()
*Deprecated*: This field is no longer supported and will start returning 0.



String
getSuggestedPriceCurrencyCode()
The suggested price currency (ISO 4217 code).



Long
getSuggestedPriceMicros()
The latest suggested price in micros (1 millionth of a standard unit, 1 USD = 1000000 micros)
 for the product.



PriceInsights
set(String fieldName,
   Object value) 


PriceInsights
setEffectiveness(String effectiveness)
The predicted effectiveness of applying the price suggestion, bucketed.



PriceInsights
setPredictedClicksChangeFraction(Double predictedClicksChangeFraction)
The predicted change in clicks as a fraction after introducing the suggested price compared to
 current active price.



PriceInsights
setPredictedConversionsChangeFraction(Double predictedConversionsChangeFraction)
The predicted change in conversions as a fraction after introducing the suggested price
 compared to current active price.



PriceInsights
setPredictedGrossProfitChangeFraction(Double predictedGrossProfitChangeFraction)
*Deprecated*: This field is no longer supported and will start returning 0.



PriceInsights
setPredictedImpressionsChangeFraction(Double predictedImpressionsChangeFraction)
The predicted change in impressions as a fraction after introducing the suggested price
 compared to current active price.



PriceInsights
setPredictedMonthlyGrossProfitChangeCurrencyCode(String predictedMonthlyGrossProfitChangeCurrencyCode)
*Deprecated*: This field is no longer supported and will start returning USD for all requests.



PriceInsights
setPredictedMonthlyGrossProfitChangeMicros(Long predictedMonthlyGrossProfitChangeMicros)
*Deprecated*: This field is no longer supported and will start returning 0.



PriceInsights
setSuggestedPriceCurrencyCode(String suggestedPriceCurrencyCode)
The suggested price currency (ISO 4217 code).



PriceInsights
setSuggestedPriceMicros(Long suggestedPriceMicros)
The latest suggested price in micros (1 millionth of a standard unit, 1 USD = 1000000 micros)
 for the product.







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





PriceInsights
public PriceInsights()









Method Detail





getEffectiveness
public String getEffectiveness()
The predicted effectiveness of applying the price suggestion, bucketed.

Returns:
value or null for none








setEffectiveness
public PriceInsights setEffectiveness(String effectiveness)
The predicted effectiveness of applying the price suggestion, bucketed.

Parameters:
effectiveness - effectiveness or null for none








getPredictedClicksChangeFraction
public Double getPredictedClicksChangeFraction()
The predicted change in clicks as a fraction after introducing the suggested price compared to
 current active price. For example, 0.05 is a 5% predicted increase in clicks.

Returns:
value or null for none








setPredictedClicksChangeFraction
public PriceInsights setPredictedClicksChangeFraction(Double predictedClicksChangeFraction)
The predicted change in clicks as a fraction after introducing the suggested price compared to
 current active price. For example, 0.05 is a 5% predicted increase in clicks.

Parameters:
predictedClicksChangeFraction - predictedClicksChangeFraction or null for none








getPredictedConversionsChangeFraction
public Double getPredictedConversionsChangeFraction()
The predicted change in conversions as a fraction after introducing the suggested price
 compared to current active price. For example, 0.05 is a 5% predicted increase in conversions).

Returns:
value or null for none








setPredictedConversionsChangeFraction
public PriceInsights setPredictedConversionsChangeFraction(Double predictedConversionsChangeFraction)
The predicted change in conversions as a fraction after introducing the suggested price
 compared to current active price. For example, 0.05 is a 5% predicted increase in conversions).

Parameters:
predictedConversionsChangeFraction - predictedConversionsChangeFraction or null for none








getPredictedGrossProfitChangeFraction
public Double getPredictedGrossProfitChangeFraction()
*Deprecated*: This field is no longer supported and will start returning 0. The predicted
 change in gross profit as a fraction after introducing the suggested price compared to current
 active price. For example, 0.05 is a 5% predicted increase in gross profit.

Returns:
value or null for none








setPredictedGrossProfitChangeFraction
public PriceInsights setPredictedGrossProfitChangeFraction(Double predictedGrossProfitChangeFraction)
*Deprecated*: This field is no longer supported and will start returning 0. The predicted
 change in gross profit as a fraction after introducing the suggested price compared to current
 active price. For example, 0.05 is a 5% predicted increase in gross profit.

Parameters:
predictedGrossProfitChangeFraction - predictedGrossProfitChangeFraction or null for none








getPredictedImpressionsChangeFraction
public Double getPredictedImpressionsChangeFraction()
The predicted change in impressions as a fraction after introducing the suggested price
 compared to current active price. For example, 0.05 is a 5% predicted increase in impressions.

Returns:
value or null for none








setPredictedImpressionsChangeFraction
public PriceInsights setPredictedImpressionsChangeFraction(Double predictedImpressionsChangeFraction)
The predicted change in impressions as a fraction after introducing the suggested price
 compared to current active price. For example, 0.05 is a 5% predicted increase in impressions.

Parameters:
predictedImpressionsChangeFraction - predictedImpressionsChangeFraction or null for none








getPredictedMonthlyGrossProfitChangeCurrencyCode
public String getPredictedMonthlyGrossProfitChangeCurrencyCode()
*Deprecated*: This field is no longer supported and will start returning USD for all requests.
 The predicted monthly gross profit change currency (ISO 4217 code).

Returns:
value or null for none








setPredictedMonthlyGrossProfitChangeCurrencyCode
public PriceInsights setPredictedMonthlyGrossProfitChangeCurrencyCode(String predictedMonthlyGrossProfitChangeCurrencyCode)
*Deprecated*: This field is no longer supported and will start returning USD for all requests.
 The predicted monthly gross profit change currency (ISO 4217 code).

Parameters:
predictedMonthlyGrossProfitChangeCurrencyCode - predictedMonthlyGrossProfitChangeCurrencyCode or null for none








getPredictedMonthlyGrossProfitChangeMicros
public Long getPredictedMonthlyGrossProfitChangeMicros()
*Deprecated*: This field is no longer supported and will start returning 0. The predicted
 change in gross profit in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) after
 introducing the suggested price for a month compared to current active price.

Returns:
value or null for none








setPredictedMonthlyGrossProfitChangeMicros
public PriceInsights setPredictedMonthlyGrossProfitChangeMicros(Long predictedMonthlyGrossProfitChangeMicros)
*Deprecated*: This field is no longer supported and will start returning 0. The predicted
 change in gross profit in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) after
 introducing the suggested price for a month compared to current active price.

Parameters:
predictedMonthlyGrossProfitChangeMicros - predictedMonthlyGrossProfitChangeMicros or null for none








getSuggestedPriceCurrencyCode
public String getSuggestedPriceCurrencyCode()
The suggested price currency (ISO 4217 code).

Returns:
value or null for none








setSuggestedPriceCurrencyCode
public PriceInsights setSuggestedPriceCurrencyCode(String suggestedPriceCurrencyCode)
The suggested price currency (ISO 4217 code).

Parameters:
suggestedPriceCurrencyCode - suggestedPriceCurrencyCode or null for none








getSuggestedPriceMicros
public Long getSuggestedPriceMicros()
The latest suggested price in micros (1 millionth of a standard unit, 1 USD = 1000000 micros)
 for the product.

Returns:
value or null for none








setSuggestedPriceMicros
public PriceInsights setSuggestedPriceMicros(Long suggestedPriceMicros)
The latest suggested price in micros (1 millionth of a standard unit, 1 USD = 1000000 micros)
 for the product.

Parameters:
suggestedPriceMicros - suggestedPriceMicros or null for none








set
public PriceInsights set(String fieldName,
                         Object value)

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








clone
public PriceInsights clone()

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














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`PriceInsights`	`clone()`
`String`	`getEffectiveness()` The predicted effectiveness of applying the price suggestion, bucketed.
`Double`	`getPredictedClicksChangeFraction()` The predicted change in clicks as a fraction after introducing the suggested price compared to current active price.
`Double`	`getPredictedConversionsChangeFraction()` The predicted change in conversions as a fraction after introducing the suggested price compared to current active price.
`Double`	`getPredictedGrossProfitChangeFraction()` Deprecated: This field is no longer supported and will start returning 0.
`Double`	`getPredictedImpressionsChangeFraction()` The predicted change in impressions as a fraction after introducing the suggested price compared to current active price.
`String`	`getPredictedMonthlyGrossProfitChangeCurrencyCode()` Deprecated: This field is no longer supported and will start returning USD for all requests.
`Long`	`getPredictedMonthlyGrossProfitChangeMicros()` Deprecated: This field is no longer supported and will start returning 0.
`String`	`getSuggestedPriceCurrencyCode()` The suggested price currency (ISO 4217 code).
`Long`	`getSuggestedPriceMicros()` The latest suggested price in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) for the product.
`PriceInsights`	`set(String fieldName, Object value)`
`PriceInsights`	`setEffectiveness(String effectiveness)` The predicted effectiveness of applying the price suggestion, bucketed.
`PriceInsights`	`setPredictedClicksChangeFraction(Double predictedClicksChangeFraction)` The predicted change in clicks as a fraction after introducing the suggested price compared to current active price.
`PriceInsights`	`setPredictedConversionsChangeFraction(Double predictedConversionsChangeFraction)` The predicted change in conversions as a fraction after introducing the suggested price compared to current active price.
`PriceInsights`	`setPredictedGrossProfitChangeFraction(Double predictedGrossProfitChangeFraction)` Deprecated: This field is no longer supported and will start returning 0.
`PriceInsights`	`setPredictedImpressionsChangeFraction(Double predictedImpressionsChangeFraction)` The predicted change in impressions as a fraction after introducing the suggested price compared to current active price.
`PriceInsights`	`setPredictedMonthlyGrossProfitChangeCurrencyCode(String predictedMonthlyGrossProfitChangeCurrencyCode)` Deprecated: This field is no longer supported and will start returning USD for all requests.
`PriceInsights`	`setPredictedMonthlyGrossProfitChangeMicros(Long predictedMonthlyGrossProfitChangeMicros)` Deprecated: This field is no longer supported and will start returning 0.
`PriceInsights`	`setSuggestedPriceCurrencyCode(String suggestedPriceCurrencyCode)` The suggested price currency (ISO 4217 code).
`PriceInsights`	`setSuggestedPriceMicros(Long suggestedPriceMicros)` The latest suggested price in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) for the product.