Types

Index

InventoryStatus

Status of the product cluster or brand in your inventory.

Enums
INVENTORY_STATUS_UNSPECIFIED Not specified.
IN_STOCK You have a product for this product cluster or brand in stock.
OUT_OF_STOCK You have a product for this product cluster or brand in inventory but it is currently out of stock.
NOT_IN_INVENTORY You do not have a product for this product cluster or brand in inventory.

MarketingMethodEnum

Marketing method values.

Enums
MARKETING_METHOD_ENUM_UNSPECIFIED Not specified.
ORGANIC Organic marketing.
ADS Ads-based marketing.

Effectiveness

Predicted effectiveness bucket.

Effectiveness indicates which products would benefit most from price changes. This rating takes into consideration the performance boost predicted by adjusting the sale price and the difference between your current price and the suggested price. Price suggestions with HIGH effectiveness are predicted to drive the largest increase in performance.

Enums
EFFECTIVENESS_UNSPECIFIED Effectiveness is unknown.
LOW Effectiveness is low.
MEDIUM Effectiveness is medium.
HIGH Effectiveness is high.

AggregatedReportingContextStatus

Status of the product aggregated for all reporting contexts.

Reporting contexts included in the computation of the aggregated status can be restricted using a filter on the reporting_context field.

Here's an example of how the aggregated status is computed:

Free listings Shopping ads Status
Approved Approved ELIGIBLE
Approved Pending ELIGIBLE
Approved Disapproved ELIGIBLE_LIMITED
Pending Pending PENDING
Disapproved Disapproved NOT_ELIGIBLE_OR_DISAPPROVED
Enums
AGGREGATED_REPORTING_CONTEXT_STATUS_UNSPECIFIED Not specified.
NOT_ELIGIBLE_OR_DISAPPROVED Product is not eligible or is disapproved for all reporting contexts and countries.
PENDING Product's status is pending in all reporting contexts and countries.
ELIGIBLE_LIMITED Product is eligible for some (but not all) reporting contexts and countries.
ELIGIBLE Product is eligible for all reporting contexts and countries.

ClickPotential

A product's click potential estimates its performance potential compared to highest performing products of the merchant. Click potential of a product helps merchants to prioritize which products to fix and helps them understand how products are performing against their potential.

Enums
CLICK_POTENTIAL_UNSPECIFIED Unknown predicted clicks impact.
LOW Potential to receive a low number of clicks compared to the highest performing products of the merchant.
MEDIUM Potential to receive a moderate number of clicks compared to the highest performing products of the merchant.
HIGH Potential to receive a similar number of clicks as the highest performing products of the merchant.

ItemIssue

Item issue associated with the product.

Fields
type

ItemIssueType

Item issue type.
severity

ItemIssueSeverity

Item issue severity.
resolution

ItemIssueResolution

Item issue resolution.

ItemIssueResolution

How to resolve the issue.

Enums
ITEM_ISSUE_RESOLUTION_UNSPECIFIED Not specified.
MERCHANT_ACTION The merchant has to fix the issue.
PENDING_PROCESSING The issue will be resolved automatically (for example, image crawl) or through a Google review. No merchant action is required now. Resolution might lead to another issue (for example, if crawl fails).

ItemIssueSeverity

How the issue affects the serving of the product.

Fields
severity_per_reporting_context[]

IssueSeverityPerReportingContext

Issue severity per reporting context.

Reporting contexts included in this list can be restricted using a filter on the reporting_context field.
aggregated_severity

AggregatedIssueSeverity

Aggregated severity of the issue for all reporting contexts it affects.

Reporting contexts included in the computation of the aggregated severity can be restricted using a filter on the reporting_context field.

This field can be used for filtering the results.

AggregatedIssueSeverity

Issue severity aggregated for all reporting contexts.

Enums
AGGREGATED_ISSUE_SEVERITY_UNSPECIFIED Not specified.
DISAPPROVED Issue disapproves the product in at least one reporting context.
DEMOTED Issue demotes the product in all reporting contexts it affects.
PENDING Issue resolution is PENDING_PROCESSING.

IssueSeverityPerReportingContext

Issue severity per reporting context.

Fields
disapproved_countries[]

string

List of disapproved countries in the reporting context, represented in ISO 3166 format.
demoted_countries[]

string

List of demoted countries in the reporting context, represented in ISO 3166 format.
reporting_context

ReportingContextEnum

Reporting context the issue applies to.

ItemIssueType

Issue type.

Fields
code

string

Error code of the issue, equivalent to the code of Product issues.
canonical_attribute

string

Canonical attribute name for attribute-specific issues.

StatusPerReportingContext

Status of the product for a specific reporting context.

Equivalent to DestinationStatus in Products API.

Fields
approved_countries[]

string

List of approved countries in the reporting context, represented in ISO 3166 format, for example, US.
disapproved_countries[]

string

List of disapproved countries in the reporting context, represented in ISO 3166 format, for example, US.
pending_countries[]

string

List of pending countries in the reporting context, represented in ISO 3166 format, for example, US.
reporting_context

ReportingContextEnum

Reporting context the status applies to.

RelativeDemandEnum

Relative demand values.

Enums
RELATIVE_DEMAND_ENUM_UNSPECIFIED Not specified.
VERY_LOW Demand is 0-5% of the demand of the highest ranked product cluster or brand.
LOW Demand is 6-10% of the demand of the highest ranked product cluster or brand.
MEDIUM Demand is 11-20% of the demand of the highest ranked product cluster or brand.
HIGH Demand is 21-50% of the demand of the highest ranked product cluster or brand.
VERY_HIGH Demand is 51-100% of the demand of the highest ranked product cluster or brand.

RelativeDemandChangeTypeEnum

Relative demand change type values.

Enums
RELATIVE_DEMAND_CHANGE_TYPE_ENUM_UNSPECIFIED Not specified.
SINKER Relative demand is lower than the previous time period.
FLAT Relative demand is equal to the previous time period.
RISER Relative demand is higher than the previous time period.

ReportGranularityEnum

Report granularity values.

Enums
REPORT_GRANULARITY_ENUM_UNSPECIFIED Not specified.
WEEKLY Report is computed over a week timeframe.
MONTHLY Report is computed over a month timeframe.

StoreTypeEnum

Store types.

Enums
STORE_TYPE_ENUM_UNSPECIFIED Not specified.
ONLINE_STORE Online store.
LOCAL_STORES Local (physical) stores.

TrafficSourceEnum

Traffic source values.

Enums
TRAFFIC_SOURCE_ENUM_UNSPECIFIED Not specified.
ORGANIC Organic traffic.
ADS Traffic from ads.
ALL Organic and ads traffic.