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

Go to download

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

Show newest version







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



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













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




public final class CompetitiveVisibility
extends com.google.api.client.json.GenericJson
Fields related to [competitive visibility reports]
 (https://support.google.com/merchants/answer/11366442).

  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


CompetitiveVisibility() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


CompetitiveVisibility
clone() 


Double
getAdsOrganicRatio()
[Ads / organic ratio] (https://support.google.com/merchants/answer/11366442#zippy=%2Cadsfree-
 ratio) shows how often a merchant receives impressions from Shopping ads compared to organic
 traffic.



Double
getCategoryBenchmarkVisibilityTrend()
Change in visibility based on impressions with respect to the start of the selected time range
 (or first day with non-zero impressions) for a combined set of merchants with highest
 visibility approximating the market.



Long
getCategoryId()
Google product category ID to calculate the report for, represented in [Google's product
 taxonomy](https://support.google.com/merchants/answer/6324436).



String
getCountryCode()
The country where impression appeared.



Date
getDate()
Date of this row.



String
getDomain()
Domain of your competitor or your domain, if 'is_your_domain' is true.



Double
getHigherPositionRate()
Higher position rate shows how often a competitor’s offer got placed in a higher position on
 the page than your offer.



Boolean
getIsYourDomain()
True if this row contains data for your domain.



Double
getPageOverlapRate()
Page overlap rate describes how frequently competing retailers’ offers are shown together with
 your offers on the same page.



BigInteger
getRank()
Position of the domain in the top merchants ranking for the selected keys (`date`,
 `category_id`, `country_code`, `listing_type`) based on impressions.



Double
getRelativeVisibility()
Relative visibility shows how often your competitors’ offers are shown compared to your offers.



String
getTrafficSource()
Type of impression listing.



Double
getYourDomainVisibilityTrend()
Change in visibility based on impressions for your domain with respect to the start of the
 selected time range (or first day with non-zero impressions).



CompetitiveVisibility
set(String fieldName,
   Object value) 


CompetitiveVisibility
setAdsOrganicRatio(Double adsOrganicRatio)
[Ads / organic ratio] (https://support.google.com/merchants/answer/11366442#zippy=%2Cadsfree-
 ratio) shows how often a merchant receives impressions from Shopping ads compared to organic
 traffic.



CompetitiveVisibility
setCategoryBenchmarkVisibilityTrend(Double categoryBenchmarkVisibilityTrend)
Change in visibility based on impressions with respect to the start of the selected time range
 (or first day with non-zero impressions) for a combined set of merchants with highest
 visibility approximating the market.



CompetitiveVisibility
setCategoryId(Long categoryId)
Google product category ID to calculate the report for, represented in [Google's product
 taxonomy](https://support.google.com/merchants/answer/6324436).



CompetitiveVisibility
setCountryCode(String countryCode)
The country where impression appeared.



CompetitiveVisibility
setDate(Date date)
Date of this row.



CompetitiveVisibility
setDomain(String domain)
Domain of your competitor or your domain, if 'is_your_domain' is true.



CompetitiveVisibility
setHigherPositionRate(Double higherPositionRate)
Higher position rate shows how often a competitor’s offer got placed in a higher position on
 the page than your offer.



CompetitiveVisibility
setIsYourDomain(Boolean isYourDomain)
True if this row contains data for your domain.



CompetitiveVisibility
setPageOverlapRate(Double pageOverlapRate)
Page overlap rate describes how frequently competing retailers’ offers are shown together with
 your offers on the same page.



CompetitiveVisibility
setRank(BigInteger rank)
Position of the domain in the top merchants ranking for the selected keys (`date`,
 `category_id`, `country_code`, `listing_type`) based on impressions.



CompetitiveVisibility
setRelativeVisibility(Double relativeVisibility)
Relative visibility shows how often your competitors’ offers are shown compared to your offers.



CompetitiveVisibility
setTrafficSource(String trafficSource)
Type of impression listing.



CompetitiveVisibility
setYourDomainVisibilityTrend(Double yourDomainVisibilityTrend)
Change in visibility based on impressions for your domain with respect to the start of the
 selected time range (or first day with non-zero impressions).







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





CompetitiveVisibility
public CompetitiveVisibility()









Method Detail





getAdsOrganicRatio
public Double getAdsOrganicRatio()
[Ads / organic ratio] (https://support.google.com/merchants/answer/11366442#zippy=%2Cadsfree-
 ratio) shows how often a merchant receives impressions from Shopping ads compared to organic
 traffic. The number is rounded and bucketed. Available only in
 `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be
 filtered on in the 'WHERE' clause.

Returns:
value or null for none








setAdsOrganicRatio
public CompetitiveVisibility setAdsOrganicRatio(Double adsOrganicRatio)
[Ads / organic ratio] (https://support.google.com/merchants/answer/11366442#zippy=%2Cadsfree-
 ratio) shows how often a merchant receives impressions from Shopping ads compared to organic
 traffic. The number is rounded and bucketed. Available only in
 `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be
 filtered on in the 'WHERE' clause.

Parameters:
adsOrganicRatio - adsOrganicRatio or null for none








getCategoryBenchmarkVisibilityTrend
public Double getCategoryBenchmarkVisibilityTrend()
Change in visibility based on impressions with respect to the start of the selected time range
 (or first day with non-zero impressions) for a combined set of merchants with highest
 visibility approximating the market. Available only in `CompetitiveVisibilityBenchmarkView`.
 Cannot be filtered on in the 'WHERE' clause.

Returns:
value or null for none








setCategoryBenchmarkVisibilityTrend
public CompetitiveVisibility setCategoryBenchmarkVisibilityTrend(Double categoryBenchmarkVisibilityTrend)
Change in visibility based on impressions with respect to the start of the selected time range
 (or first day with non-zero impressions) for a combined set of merchants with highest
 visibility approximating the market. Available only in `CompetitiveVisibilityBenchmarkView`.
 Cannot be filtered on in the 'WHERE' clause.

Parameters:
categoryBenchmarkVisibilityTrend - categoryBenchmarkVisibilityTrend or null for none








getCategoryId
public Long getCategoryId()
Google product category ID to calculate the report for, represented in [Google's product
 taxonomy](https://support.google.com/merchants/answer/6324436). Required in the `SELECT`
 clause. A `WHERE` condition on `competitive_visibility.category_id` is required in the query.

Returns:
value or null for none








setCategoryId
public CompetitiveVisibility setCategoryId(Long categoryId)
Google product category ID to calculate the report for, represented in [Google's product
 taxonomy](https://support.google.com/merchants/answer/6324436). Required in the `SELECT`
 clause. A `WHERE` condition on `competitive_visibility.category_id` is required in the query.

Parameters:
categoryId - categoryId or null for none








getCountryCode
public String getCountryCode()
The country where impression appeared. Required in the `SELECT` clause. A `WHERE` condition on
 `competitive_visibility.country_code` is required in the query.

Returns:
value or null for none








setCountryCode
public CompetitiveVisibility setCountryCode(String countryCode)
The country where impression appeared. Required in the `SELECT` clause. A `WHERE` condition on
 `competitive_visibility.country_code` is required in the query.

Parameters:
countryCode - countryCode or null for none








getDate
public Date getDate()
Date of this row. Available only in `CompetitiveVisibilityBenchmarkView` and
 `CompetitiveVisibilityCompetitorView`. Required in the `SELECT` clause for
 `CompetitiveVisibilityMarketBenchmarkView`.

Returns:
value or null for none








setDate
public CompetitiveVisibility setDate(Date date)
Date of this row. Available only in `CompetitiveVisibilityBenchmarkView` and
 `CompetitiveVisibilityCompetitorView`. Required in the `SELECT` clause for
 `CompetitiveVisibilityMarketBenchmarkView`.

Parameters:
date - date or null for none








getDomain
public String getDomain()
Domain of your competitor or your domain, if 'is_your_domain' is true. Available only in
 `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Required in
 the `SELECT` clause for `CompetitiveVisibilityTopMerchantView` and
 `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.

Returns:
value or null for none








setDomain
public CompetitiveVisibility setDomain(String domain)
Domain of your competitor or your domain, if 'is_your_domain' is true. Available only in
 `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Required in
 the `SELECT` clause for `CompetitiveVisibilityTopMerchantView` and
 `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.

Parameters:
domain - domain or null for none








getHigherPositionRate
public Double getHigherPositionRate()
Higher position rate shows how often a competitor’s offer got placed in a higher position on
 the page than your offer. Available only in `CompetitiveVisibilityTopMerchantView` and
 `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.

Returns:
value or null for none








setHigherPositionRate
public CompetitiveVisibility setHigherPositionRate(Double higherPositionRate)
Higher position rate shows how often a competitor’s offer got placed in a higher position on
 the page than your offer. Available only in `CompetitiveVisibilityTopMerchantView` and
 `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.

Parameters:
higherPositionRate - higherPositionRate or null for none








getIsYourDomain
public Boolean getIsYourDomain()
True if this row contains data for your domain. Available only in
 `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be
 filtered on in the 'WHERE' clause.

Returns:
value or null for none








setIsYourDomain
public CompetitiveVisibility setIsYourDomain(Boolean isYourDomain)
True if this row contains data for your domain. Available only in
 `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be
 filtered on in the 'WHERE' clause.

Parameters:
isYourDomain - isYourDomain or null for none








getPageOverlapRate
public Double getPageOverlapRate()
Page overlap rate describes how frequently competing retailers’ offers are shown together with
 your offers on the same page. Available only in `CompetitiveVisibilityTopMerchantView` and
 `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.

Returns:
value or null for none








setPageOverlapRate
public CompetitiveVisibility setPageOverlapRate(Double pageOverlapRate)
Page overlap rate describes how frequently competing retailers’ offers are shown together with
 your offers on the same page. Available only in `CompetitiveVisibilityTopMerchantView` and
 `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.

Parameters:
pageOverlapRate - pageOverlapRate or null for none








getRank
public BigInteger getRank()
Position of the domain in the top merchants ranking for the selected keys (`date`,
 `category_id`, `country_code`, `listing_type`) based on impressions. 1 is the highest.
 Available only in `CompetitiveVisibilityTopMerchantView` and
 `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.

Returns:
value or null for none








setRank
public CompetitiveVisibility setRank(BigInteger rank)
Position of the domain in the top merchants ranking for the selected keys (`date`,
 `category_id`, `country_code`, `listing_type`) based on impressions. 1 is the highest.
 Available only in `CompetitiveVisibilityTopMerchantView` and
 `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.

Parameters:
rank - rank or null for none








getRelativeVisibility
public Double getRelativeVisibility()
Relative visibility shows how often your competitors’ offers are shown compared to your offers.
 In other words, this is the number of displayed impressions of a competitor retailer divided by
 the number of your displayed impressions during a selected time range for a selected product
 category and country. Available only in `CompetitiveVisibilityCompetitorView`. Cannot be
 filtered on in the 'WHERE' clause.

Returns:
value or null for none








setRelativeVisibility
public CompetitiveVisibility setRelativeVisibility(Double relativeVisibility)
Relative visibility shows how often your competitors’ offers are shown compared to your offers.
 In other words, this is the number of displayed impressions of a competitor retailer divided by
 the number of your displayed impressions during a selected time range for a selected product
 category and country. Available only in `CompetitiveVisibilityCompetitorView`. Cannot be
 filtered on in the 'WHERE' clause.

Parameters:
relativeVisibility - relativeVisibility or null for none








getTrafficSource
public String getTrafficSource()
Type of impression listing. Required in the `SELECT` clause. Cannot be filtered on in the
 'WHERE' clause.

Returns:
value or null for none








setTrafficSource
public CompetitiveVisibility setTrafficSource(String trafficSource)
Type of impression listing. Required in the `SELECT` clause. Cannot be filtered on in the
 'WHERE' clause.

Parameters:
trafficSource - trafficSource or null for none








getYourDomainVisibilityTrend
public Double getYourDomainVisibilityTrend()
Change in visibility based on impressions for your domain with respect to the start of the
 selected time range (or first day with non-zero impressions). Available only in
 `CompetitiveVisibilityBenchmarkView`. Cannot be filtered on in the 'WHERE' clause.

Returns:
value or null for none








setYourDomainVisibilityTrend
public CompetitiveVisibility setYourDomainVisibilityTrend(Double yourDomainVisibilityTrend)
Change in visibility based on impressions for your domain with respect to the start of the
 selected time range (or first day with non-zero impressions). Available only in
 `CompetitiveVisibilityBenchmarkView`. Cannot be filtered on in the 'WHERE' clause.

Parameters:
yourDomainVisibilityTrend - yourDomainVisibilityTrend or null for none








set
public CompetitiveVisibility set(String fieldName,
                                 Object value)

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








clone
public CompetitiveVisibility 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
`CompetitiveVisibility`	`clone()`
`Double`	`getAdsOrganicRatio()` [Ads / organic ratio] (https://support.google.com/merchants/answer/11366442#zippy=%2Cadsfree- ratio) shows how often a merchant receives impressions from Shopping ads compared to organic traffic.
`Double`	`getCategoryBenchmarkVisibilityTrend()` Change in visibility based on impressions with respect to the start of the selected time range (or first day with non-zero impressions) for a combined set of merchants with highest visibility approximating the market.
`Long`	`getCategoryId()` Google product category ID to calculate the report for, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).
`String`	`getCountryCode()` The country where impression appeared.
`Date`	`getDate()` Date of this row.
`String`	`getDomain()` Domain of your competitor or your domain, if 'is_your_domain' is true.
`Double`	`getHigherPositionRate()` Higher position rate shows how often a competitor’s offer got placed in a higher position on the page than your offer.
`Boolean`	`getIsYourDomain()` True if this row contains data for your domain.
`Double`	`getPageOverlapRate()` Page overlap rate describes how frequently competing retailers’ offers are shown together with your offers on the same page.
`BigInteger`	`getRank()` Position of the domain in the top merchants ranking for the selected keys (`date`, `category_id`, `country_code`, `listing_type`) based on impressions.
`Double`	`getRelativeVisibility()` Relative visibility shows how often your competitors’ offers are shown compared to your offers.
`String`	`getTrafficSource()` Type of impression listing.
`Double`	`getYourDomainVisibilityTrend()` Change in visibility based on impressions for your domain with respect to the start of the selected time range (or first day with non-zero impressions).
`CompetitiveVisibility`	`set(String fieldName, Object value)`
`CompetitiveVisibility`	`setAdsOrganicRatio(Double adsOrganicRatio)` [Ads / organic ratio] (https://support.google.com/merchants/answer/11366442#zippy=%2Cadsfree- ratio) shows how often a merchant receives impressions from Shopping ads compared to organic traffic.
`CompetitiveVisibility`	`setCategoryBenchmarkVisibilityTrend(Double categoryBenchmarkVisibilityTrend)` Change in visibility based on impressions with respect to the start of the selected time range (or first day with non-zero impressions) for a combined set of merchants with highest visibility approximating the market.
`CompetitiveVisibility`	`setCategoryId(Long categoryId)` Google product category ID to calculate the report for, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).
`CompetitiveVisibility`	`setCountryCode(String countryCode)` The country where impression appeared.
`CompetitiveVisibility`	`setDate(Date date)` Date of this row.
`CompetitiveVisibility`	`setDomain(String domain)` Domain of your competitor or your domain, if 'is_your_domain' is true.
`CompetitiveVisibility`	`setHigherPositionRate(Double higherPositionRate)` Higher position rate shows how often a competitor’s offer got placed in a higher position on the page than your offer.
`CompetitiveVisibility`	`setIsYourDomain(Boolean isYourDomain)` True if this row contains data for your domain.
`CompetitiveVisibility`	`setPageOverlapRate(Double pageOverlapRate)` Page overlap rate describes how frequently competing retailers’ offers are shown together with your offers on the same page.
`CompetitiveVisibility`	`setRank(BigInteger rank)` Position of the domain in the top merchants ranking for the selected keys (`date`, `category_id`, `country_code`, `listing_type`) based on impressions.
`CompetitiveVisibility`	`setRelativeVisibility(Double relativeVisibility)` Relative visibility shows how often your competitors’ offers are shown compared to your offers.
`CompetitiveVisibility`	`setTrafficSource(String trafficSource)` Type of impression listing.
`CompetitiveVisibility`	`setYourDomainVisibilityTrend(Double yourDomainVisibilityTrend)` Change in visibility based on impressions for your domain with respect to the start of the selected time range (or first day with non-zero impressions).