Namespace Google.Apis.ShoppingContent.v2_1.Data

Classes

Account

Account data. After the creation of a new account it may take a few minutes before it's fully operational. The methods delete, insert, and update require the admin role.

AccountAutomaticImprovements

The automatic improvements of the account can be used to automatically update items, improve images and shipping.

AccountBusinessIdentity

The business identity attributes can be used to self-declare attributes that let customers know more about your business.

AccountCredentials

Credentials allowing Google to call a partner's API on behalf of a merchant.

AccountIdentityType

The account identity type used to specify attributes.

This improvement will attempt to automatically correct submitted images if they don't meet the image requirements, for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: Automatic image improvements

AccountImageImprovementsSettings

Settings for the Automatic Image Improvements.

AccountIssue

An issue affecting specific merchant.

AccountIssueImpact

Overall impact of the issue.

AccountItemUpdates

Turning on item updates allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown.

AccountItemUpdatesSettings

Settings for the Automatic Item Updates.

AccountLabel

Label assigned by CSS domain or CSS group to one of its sub-accounts.

AccountReturnCarrier

The return carrier information. This service is designed for merchants enrolled in the Buy on Google program.

AccountShippingImprovements

Not available for MCAs accounts. By turning on automatic shipping improvements, you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data

AccountStatus

The status of an account, that is, information about its products, which is computed offline and not returned immediately at insertion time.

AccountStatusAccountLevelIssue

AccountStatusItemLevelIssue

AccountStatusProducts

AccountStatusStatistics

AccountTax

The tax settings of a merchant account. All methods require the admin role.

AccountTaxTaxRule

Tax calculation rule to apply in a state or province (US only).

AccountUser

AccountYouTubeChannelLink

AccountsAuthInfoResponse

AccountsClaimWebsiteResponse

AccountsCustomBatchRequest

AccountsCustomBatchRequestEntry

A batch entry encoding a single non-batch accounts request.

AccountsCustomBatchRequestEntryLinkRequest

AccountsCustomBatchResponse

AccountsCustomBatchResponseEntry

A batch entry encoding a single non-batch accounts response.

AccountsLinkRequest

AccountsLinkResponse

AccountsListLinksResponse

AccountsListResponse

AccountsUpdateLabelsRequest

AccountsUpdateLabelsResponse

AccountstatusesCustomBatchRequest

AccountstatusesCustomBatchRequestEntry

A batch entry encoding a single non-batch accountstatuses request.

AccountstatusesCustomBatchResponse

AccountstatusesCustomBatchResponseEntry

A batch entry encoding a single non-batch accountstatuses response.

AccountstatusesListResponse

AccounttaxCustomBatchRequest

AccounttaxCustomBatchRequestEntry

A batch entry encoding a single non-batch accounttax request.

AccounttaxCustomBatchResponse

AccounttaxCustomBatchResponseEntry

A batch entry encoding a single non-batch accounttax response.

AccounttaxListResponse

Action

An actionable step that can be executed to solve the issue.

ActionFlow

Flow that can be selected for an action. When merchant selects a flow, application should open a dialog with more information and input form.

ActionInput

Input provided by the merchant.

ActionReason

A single reason why the action is not available.

Address

AlternateDisputeResolution

The Alternate Dispute Resolution (ADR) that may be available to merchants in some regions. If present, the link should be shown on the same page as the list of issues.

AttributionSettings

Represents attribution settings for conversion sources receiving pre-attribution data.

AttributionSettingsConversionType

Message representing a types of conversion events

BestSellers

Fields related to the Best sellers reports.

Brand

Brand fields. Values are only set for fields requested explicitly in the request's search query.

Breakdown

A detailed impact breakdown for a group of regions where the impact of the issue on different shopping destinations is the same.

BreakdownRegion

Region with code and localized name.

BuiltInSimpleAction

Action that is implemented and performed in (your) third-party application. Represents various functionality that is expected to be available to merchant and will help them with resolving the issue. The application should point the merchant to the place, where they can access the corresponding functionality. If the functionality is not supported, it is recommended to explain the situation to merchant and provide them with instructions how to solve the issue.

BuiltInSimpleActionAdditionalContent

Long text from external source.

BuiltInUserInputAction

Action that is implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the merchant. They can start the action only when they provided all required inputs. The application will request processing of the action by calling the triggeraction method.

BusinessDayConfig

Callout

An important message that should be highlighted. Usually displayed as a banner.

CarrierRate

CarriersCarrier

CheckoutSettings

CheckoutSettings for a specific merchant ID.

CloudExportAdditionalProperties

Product property for the Cloud Retail API. For example, properties for a TV product could be "Screen-Resolution" or "Screen-Size".

Collection

The collection message.

CollectionFeaturedProduct

The message for FeaturedProduct. FeaturedProduct

CollectionStatus

The collectionstatus message.

CollectionStatusDestinationStatus

Destination status message.

CollectionStatusItemLevelIssue

Issue associated with the collection.

CompetitiveVisibility

Fields related to [competitive visibility reports] (https://support.google.com/merchants/answer/11366442).

ConversionSource

Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources.

Css

Information about CSS domain.

CustomAttribute

A message that represents custom attributes. Exactly one of value or groupValues must be provided. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per merchant, with total size of 102.4kB.

CutoffTime

Datafeed

Datafeed configuration data.

DatafeedFetchSchedule

The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required.

DatafeedFormat

DatafeedStatus

The status of a datafeed, that is, the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.

DatafeedStatusError

An error occurring in the feed, like "invalid price".

DatafeedStatusExample

An example occurrence for a particular error.

DatafeedTarget

DatafeedsCustomBatchRequest

DatafeedsCustomBatchRequestEntry

A batch entry encoding a single non-batch datafeeds request.

DatafeedsCustomBatchResponse

DatafeedsCustomBatchResponseEntry

A batch entry encoding a single non-batch datafeeds response.

DatafeedsFetchNowResponse

DatafeedsListResponse

DatafeedstatusesCustomBatchRequest

DatafeedstatusesCustomBatchRequestEntry

A batch entry encoding a single non-batch datafeedstatuses request.

DatafeedstatusesCustomBatchResponse

DatafeedstatusesCustomBatchResponseEntry

A batch entry encoding a single non-batch datafeedstatuses response.

DatafeedstatusesListResponse

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

DateTime

Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the time_offset oneof is set. Consider using Timestamp message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.

DeliveryArea

A delivery area for the product. Only one of countryCode or postalCodeRange must be set.

DeliveryAreaPostalCodeRange

A range of postal codes that defines the delivery area. Only set firstPostalCode when specifying a single postal code.

DeliveryTime

Distance

Distance represented by an integer and unit.

ECommercePlatformLinkInfo

Additional information required for E_COMMERCE_PLATFORM link type.

Error

An error returned by the API.

Errors

A list of errors returned by a failed batch entry.

ExternalAction

Action that is implemented and performed outside of the third-party application. It should redirect the merchant to the provided URL of an external system where they can perform the action. For example to request a review in the Merchant Center.

FreeListingsProgramStatus

Response message for GetFreeListingsProgramStatus.

FreeListingsProgramStatusRegionStatus

Status of program and region.

FreeListingsProgramStatusReviewIneligibilityReasonDetails

Additional details for review ineligibility reasons.

FreeShippingThreshold

Conditions to be met for a product to have free shipping.

GenerateRecommendationsResponse

Response containing generated recommendations.

GmbAccounts

GmbAccountsGmbAccount

GoogleAnalyticsLink

"Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account.

Headers

A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set.

HolidayCutoff

HolidaysHoliday

InputField

Input field that needs to be available to the merchant. If the field is marked as required, then a value needs to be provided for a successful processing of the request.

InputFieldCheckboxInput

Checkbox input allows merchants to provide a boolean value. Corresponds to the html input type=checkbox. If merchant checks the box, the input value for the field is true, otherwise it is false. This type of input is often used as a confirmation that the merchant completed required steps before they are allowed to start the action. In such a case, the input field is marked as required and the button to trigger the action should stay disabled until the merchant checks the box.

InputFieldChoiceInput

Choice input allows merchants to select one of the offered choices. Some choices may be linked to additional input fields that should be displayed under or next to the choice option. The value for the additional input field needs to be provided only when the specific choice is selected by the merchant. For example, additional input field can be hidden or disabled until the merchant selects the specific choice.

InputFieldChoiceInputChoiceInputOption

A choice that merchant can select.

InputFieldTextInput

Text input allows merchants to provide a text value.

InputValue

Input provided by the merchant for input field.

InputValueCheckboxInputValue

Value for checkbox input field.

InputValueChoiceInputValue

Value for choice input field.

InputValueTextInputValue

Value for text input field.

InsertCheckoutSettingsRequest

Request message for the InsertCheckoutSettings method.

Installment

Details of a monthly installment payment offering. Learn more about installments.

LabelIds

The IDs of labels that should be assigned to the CSS domain.

LiaAboutPageSettings

LiaCountrySettings

LiaInventorySettings

LiaOmnichannelExperience

Omnichannel experience details.

LiaOnDisplayToOrderSettings

LiaPosDataProvider

LiaSettings

Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.

LiasettingsCustomBatchRequest

LiasettingsCustomBatchRequestEntry

LiasettingsCustomBatchResponse

LiasettingsCustomBatchResponseEntry

LiasettingsGetAccessibleGmbAccountsResponse

LiasettingsListPosDataProvidersResponse

LiasettingsListResponse

LiasettingsRequestGmbAccessResponse

LiasettingsRequestInventoryVerificationResponse

LiasettingsSetInventoryVerificationContactResponse

LiasettingsSetPosDataProviderResponse

LinkService

LinkedAccount

ListAccountLabelsResponse

Response message for the ListAccountLabels method.

ListAccountReturnCarrierResponse

Response for listing account return carriers.

ListCollectionStatusesResponse

Response message for the ListCollectionStatuses method.

ListCollectionsResponse

Response message for the ListCollections method.

ListConversionSourcesResponse

Response message for the ListConversionSources method.

ListCssesResponse

The response message for the ListCsses method

ListMethodQuotasResponse

Response message for the ListMethodQuotas method.

ListPromotionResponse

Response message for Promotions.List method.

ListRegionsResponse

Response message for the ListRegions method.

ListReturnPolicyOnlineResponse

Response message for the ListReturnPolicyOnline method.

LocalInventory

Local inventory resource. For accepted attribute values, see the local product inventory feed specification.

LocalinventoryCustomBatchRequest

LocalinventoryCustomBatchRequestEntry

Batch entry encoding a single local inventory update request.

LocalinventoryCustomBatchResponse

LocalinventoryCustomBatchResponseEntry

Batch entry encoding a single local inventory update response.

LocationIdSet

LoyaltyProgram

Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446

MerchantCenterDestination

"Merchant Center Destination" sources can be used to send conversion events from a website using a Google tag directly to a Merchant Center account where the source is created.

MethodQuota

The quota information per method in the Content API.

Metrics

Performance metrics. Values are only set for metrics requested explicitly in the request's search query.

MinimumOrderValueTable

MinimumOrderValueTableStoreCodeSetWithMov

A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.

OrderTrackingSignal

Represents a merchant trade from which signals are extracted, e.g. shipping.

OrderTrackingSignalLineItemDetails

The line items of the order.

OrderTrackingSignalShipmentLineItemMapping

Represents how many items are in the shipment for the given shipment_id and line_item_id.

OrderTrackingSignalShippingInfo

The shipping information for the order.

PaymentServiceProviderLinkInfo

Additional information required for PAYMENT_SERVICE_PROVIDER link type.

PickupCarrierService

PickupServicesPickupService

PosCustomBatchRequest

PosCustomBatchRequestEntry

PosCustomBatchResponse

PosCustomBatchResponseEntry

PosDataProviders

PosDataProvidersPosDataProvider

PosInventory

The absolute quantity of an item available at the given store.

PosInventoryRequest

PosInventoryResponse

PosListResponse

PosSale

The change of the available quantity of an item at the given store.

PosSaleRequest

PosSaleResponse

PosStore

Store resource.

PostalCodeGroup

PostalCodeRange

Price

PriceAmount

The price represented as a number and currency.

PriceCompetitiveness

Price competitiveness fields requested by the merchant in the query. Field values are only set if the merchant queries PriceCompetitivenessProductView. https://support.google.com/merchants/answer/9626903

PriceInsights

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

Product

Required product attributes are primarily defined by the product data specification. See the Product Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. The following reference documentation lists the field names in the camelCase casing style while the Products Data Specification lists the names in the snake_case casing style.

ProductCertification

Product certification, introduced for EU energy efficiency labeling compliance using the EU EPREL database.

ProductCluster

Product cluster fields. A product cluster is a grouping for different offers that represent the same product. Values are only set for fields requested explicitly in the request's search query.

ProductDeliveryTime

The estimated days to deliver a product after an order is placed. Only authorized shipping signals partners working with a merchant can use this resource. Merchants should use the products resource instead.

ProductDeliveryTimeAreaDeliveryTime

A pairing of DeliveryArea associated with a DeliveryTime for this product.

ProductDeliveryTimeAreaDeliveryTimeDeliveryTime

A delivery time for this product.

ProductDimension

ProductId

The Content API ID of the product.

ProductIssue

An issue affecting specific product.

ProductIssueImpact

Overall impact of product issue.

ProductProductDetail

ProductShipping

ProductShippingDimension

ProductShippingWeight

ProductStatus

The status of a product, that is, information about a product computed asynchronously.

ProductStatusDestinationStatus

ProductStatusItemLevelIssue

ProductStructuredDescription

Structured description, for algorithmically (AI)-generated descriptions. See description for more information.

ProductStructuredTitle

Structured title, for algorithmically (AI)-generated titles. See title for more information.

ProductSubscriptionCost

ProductSustainabilityIncentive

Information regarding sustainability related incentive programs such as rebates or tax relief.

ProductTax

ProductUnitPricingBaseMeasure

ProductUnitPricingMeasure

ProductView

Product fields. Values are only set for fields requested explicitly in the request's search query.

ProductViewItemIssue

Item issue associated with the product.

ProductViewItemIssueIssueSeverityPerDestination

Issue severity for all affected regions in a destination.

ProductViewItemIssueItemIssueSeverity

Severity of an issue per destination in a region, and aggregated severity.

ProductViewItemIssueItemIssueType

Type of the item issue.

ProductWeight

ProductsCustomBatchRequest

ProductsCustomBatchRequestEntry

A batch entry encoding a single non-batch products request.

ProductsCustomBatchResponse

ProductsCustomBatchResponseEntry

A batch entry encoding a single non-batch products response.

ProductsListResponse

ProductstatusesCustomBatchRequest

ProductstatusesCustomBatchRequestEntry

A batch entry encoding a single non-batch productstatuses request.

ProductstatusesCustomBatchResponse

ProductstatusesCustomBatchResponseEntry

A batch entry encoding a single non-batch productstatuses response.

ProductstatusesListResponse

Promotion

Represents a promotion. See the following articles for more details. * Promotions feed specification * Local promotions feed specification * Promotions on Buy on Google product data specification

PromotionPromotionStatus

The status of the promotion.

PromotionPromotionStatusDestinationStatus

The destination status of the promotion.

PromotionPromotionStatusPromotionIssue

The issue associated with the promotion.

PubsubNotificationSettings

Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account.

RateGroup

Recommendation

Recommendations are suggested ways to improve your merchant account's performance. For example, to engage with a feature, or start using a new Google product.

RecommendationCallToAction

Call to action (CTA) that explains how a merchant can implement this recommendation

RecommendationCreative

Creative is a multimedia attachment to recommendation that can be used on the frontend.

RecommendationDescription

Google-provided description for the recommendation.

Region

Represents a geographic region that you can use as a target with both the RegionalInventory and ShippingSettings services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets.

RegionGeoTargetArea

A list of geotargets that defines the region area.

RegionPostalCodeArea

A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's ShippingSettings.postalCodeGroups resource.

RegionPostalCodeAreaPostalCodeRange

A range of postal codes that defines the region area.

RegionalInventory

Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region.

RegionalinventoryCustomBatchRequest

RegionalinventoryCustomBatchRequestEntry

A batch entry encoding a single non-batch regional inventory request.

RegionalinventoryCustomBatchResponse

RegionalinventoryCustomBatchResponseEntry

A batch entry encoding a single non-batch regional inventory response.

RenderAccountIssuesRequestPayload

The payload for configuring how the content should be rendered.

RenderAccountIssuesResponse

Response containing support content and actions for listed account issues.

RenderProductIssuesRequestPayload

The payload for configuring how the content should be rendered.

RenderProductIssuesResponse

Response containing support content and actions for listed product issues.

ReportInteractionRequest

Request to report interactions on a recommendation.

ReportRow

Result row returned from the search query.

RequestPhoneVerificationRequest

Request message for the RequestPhoneVerification method.

RequestPhoneVerificationResponse

Response message for the RequestPhoneVerification method.

RequestReviewFreeListingsRequest

Request message for the RequestReviewFreeListings Program method.

RequestReviewShoppingAdsRequest

Request message for the RequestReviewShoppingAds program method.

ReturnAddress

Return address resource.

ReturnAddressAddress

ReturnPolicy

Return policy resource.

ReturnPolicyOnline

Return policy online object. This is currently used to represent return policies for ads and free listings programs.

ReturnPolicyOnlinePolicy

The available policies.

ReturnPolicyOnlineRestockingFee

The restocking fee. This can either be a fixed fee or a micro percent.

ReturnPolicyOnlineReturnReasonCategoryInfo

The return reason category info wrapper.

ReturnPolicyOnlineReturnShippingFee

The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost.

ReturnPolicyPolicy

ReturnPolicySeasonalOverride

ReturnaddressCustomBatchRequest

ReturnaddressCustomBatchRequestEntry

ReturnaddressCustomBatchResponse

ReturnaddressCustomBatchResponseEntry

ReturnaddressListResponse

ReturnpolicyCustomBatchRequest

ReturnpolicyCustomBatchRequestEntry

ReturnpolicyCustomBatchResponse

ReturnpolicyCustomBatchResponseEntry

ReturnpolicyListResponse

Row

SearchRequest

Request message for the ReportService.Search method.

SearchResponse

Response message for the ReportService.Search method.

Segments

Dimensions according to which metrics are segmented in the response. Values of product dimensions, such as offer_id, reflect the state of a product at the time of the corresponding event, for example, 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.

Service

ServiceStoreConfig

Stores that provide local delivery. Only valid with local delivery fulfillment.

ServiceStoreConfigCutoffConfig

Time local delivery ends for the day based on the local timezone of the store. local_cutoff_time and store_close_offset_hours are mutually exclusive.

ServiceStoreConfigCutoffConfigLocalCutoffTime

Time in hours and minutes in the local timezone when local delivery ends.

ShippingSettings

The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.

ShippingsettingsCustomBatchRequest

ShippingsettingsCustomBatchRequestEntry

A batch entry encoding a single non-batch shippingsettings request.

ShippingsettingsCustomBatchResponse

ShippingsettingsCustomBatchResponseEntry

A batch entry encoding a single non-batch shipping settings response.

ShippingsettingsGetSupportedCarriersResponse

ShippingsettingsGetSupportedHolidaysResponse

ShippingsettingsGetSupportedPickupServicesResponse

ShippingsettingsListResponse

ShoppingAdsProgramStatus

Response message for GetShoppingAdsProgramStatus.

ShoppingAdsProgramStatusRegionStatus

Status of program and region.

ShoppingAdsProgramStatusReviewIneligibilityReasonDetails

Additional details for review ineligibility reasons.

Table

TextWithTooltip

Block of text that may contain a tooltip with more information.

TimePeriod

A message that represents a time period.

TimeZone

Represents a time zone from the IANA Time Zone Database.

TopicTrends

Topic trends fields requested by the merchant in the query. Field values are only set if the merchant queries TopicTrendsView. Forecast data can be queried up to 13 weeks by passing a future date in the date field. Historical data is measured daily, and forecasted data is projected weekly. All data points are normalized based on the highest data points returned in the response. If you make separate queries with different date ranges, you might see different values for the same date in each response. The recommended way to get a trend score of a topic is last7_days_search_interest / last{$day}_days_search_interest - 1. You can view trends for up to eight topics at a time.