content/v2_1 library

Content API for Shopping - v2.1

Manage your product listings and accounts for Google Shopping

For more information, see developers.google.com/shopping-content/v2/

Create an instance of ShoppingContentApi to access these resources:

Classes

Account
Account data.
AccountAddress
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.
AccountBusinessInformation
AccountConversionSettings
Settings for conversion tracking.
AccountCredentials
Credentials allowing Google to call a partner's API on behalf of a merchant.
AccountCustomerService
AccountIdentifier
AccountIdentityType
The account identity type used to specify attributes.
AccountImageImprovements
This improvement will attempt to automatically correct submitted images if they don't meet the image requirements, for example, removing overlays.
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.
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.
AccountsAuthInfoResponse
AccountsClaimWebsiteResponse
AccountsCredentialsResource
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.
AccountShippingImprovements
Not available for MCAs accounts.
AccountsLabelsResource
AccountsLinkRequest
AccountsLinkResponse
AccountsListLinksResponse
AccountsListResponse
AccountsResource
AccountsReturncarrierResource
AccountStatus
The status of an account, that is, information about its products, which is computed offline and not returned immediately at insertion time.
AccountStatusAccountLevelIssue
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
AccountstatusesResource
AccountStatusItemLevelIssue
AccountStatusProducts
AccountStatusStatistics
AccountsUpdateLabelsRequest
AccountsUpdateLabelsResponse
AccountTax
The tax settings of a merchant account.
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
AccounttaxResource
AccountTaxTaxRule
Tax calculation rule to apply in a state or province (US only).
AccountUser
Action
An actionable step that can be executed to solve the issue.
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.
Amount
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.
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.
BuiltInSimpleActionAdditionalContent
Long text from external source.
BusinessDayConfig
BuyongoogleprogramsResource
BuyOnGoogleProgramStatus
Response message for the GetProgramStatus method.
CaptureOrderResponse
Response message for the CaptureOrder method.
CarrierRate
CarriersCarrier
CheckoutSettings
CheckoutSettings for a specific merchant ID.
CloudExportAdditionalProperties
Product property for the Cloud Retail API.
Collection
The collection message.
CollectionFeaturedProduct
The message for FeaturedProduct.
CollectionsResource
CollectionStatus
The collectionstatus message.
CollectionStatusDestinationStatus
Destination status message.
CollectionstatusesResource
CollectionStatusItemLevelIssue
Issue associated with the collection.
CompetitiveVisibility
Fields related to competitive visibility reports.
ConversionSource
Represents a conversion source owned by a Merchant account.
ConversionsourcesResource
Css
Information about CSS domain.
CssesResource
CustomAttribute
A message that represents custom attributes.
CustomerReturnReason
CutoffTime
Datafeed
Datafeed configuration data.
DatafeedFetchSchedule
The required fields vary based on the frequency of fetching.
DatafeedFormat
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
DatafeedsResource
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".
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
DatafeedstatusesResource
DatafeedStatusExample
An example occurrence for a particular error.
DatafeedTarget
DateTime
Represents civil time (or occasionally physical time).
DeliveryArea
A delivery area for the product.
DeliveryAreaPostalCodeRange
A range of postal codes that defines the delivery area.
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.
FreelistingsprogramCheckoutsettingsResource
FreelistingsprogramResource
FreeListingsProgramStatus
Response message for GetFreeListingsProgramStatus.
FreeListingsProgramStatusRegionStatus
Status of program and region.
GenerateRecommendationsResponse
Response containing generated recommendations.
GmbAccounts
GmbAccountsGmbAccount
"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.
HolidayCutoff
HolidaysHoliday
InsertCheckoutSettingsRequest
Request message for the InsertCheckoutSettings method.
Installment
InvoiceSummary
InvoiceSummaryAdditionalChargeSummary
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.
LiasettingsCustomBatchRequest
LiasettingsCustomBatchRequestEntry
LiasettingsCustomBatchResponse
LiasettingsCustomBatchResponseEntry
LiasettingsGetAccessibleGmbAccountsResponse
LiasettingsListPosDataProvidersResponse
LiasettingsListResponse
LiasettingsRequestGmbAccessResponse
LiasettingsRequestInventoryVerificationResponse
LiasettingsResource
LiasettingsSetInventoryVerificationContactResponse
LiasettingsSetPosDataProviderResponse
LinkedAccount
LinkService
ListAccountLabelsResponse
Response message for the ListAccountLabels method.
ListAccountReturnCarrierResponse
Response for listing account return carriers.
ListCollectionsResponse
Response message for the ListCollections method.
ListCollectionStatusesResponse
Response message for the ListCollectionStatuses 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.
LocalinventoryCustomBatchRequest
LocalinventoryCustomBatchRequestEntry
Batch entry encoding a single local inventory update request.
LocalinventoryCustomBatchResponse
LocalinventoryCustomBatchResponseEntry
Batch entry encoding a single local inventory update response.
LocalinventoryResource
LocationIdSet
LoyaltyPoints
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.
MerchantOrderReturn
Order return.
MerchantOrderReturnItem
MerchantRejectionReason
MerchantsupportResource
MethodQuota
The quota information per method in the Content API.
Metrics
Performance metrics.
MinimumOrderValueTable
MinimumOrderValueTableStoreCodeSetWithMov
A list of store code sets sharing the same minimum order value.
MonetaryAmount
OnboardBuyOnGoogleProgramRequest
Request message for the OnboardProgram method.
Order
Order.
OrderCancellation
OrderCustomer
OrderCustomerLoyaltyInfo
OrderCustomerMarketingRightsInfo
OrderDeliveryDetails
OrderinvoicesCreateChargeInvoiceRequest
OrderinvoicesCreateChargeInvoiceResponse
OrderinvoicesCreateRefundInvoiceRequest
OrderinvoicesCreateRefundInvoiceResponse
OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption
OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption
OrderinvoicesResource
OrderLineItem
OrderLineItemAdjustment
OrderLineItemProduct
OrderLineItemProductFee
OrderLineItemProductVariantAttribute
OrderLineItemReturnInfo
OrderLineItemShippingDetails
OrderLineItemShippingDetailsMethod
OrderMerchantProvidedAnnotation
OrderOrderAnnotation
OrderPickupDetails
OrderPickupDetailsCollector
OrderPromotion
OrderPromotionItem
OrderRefund
OrderReportDisbursement
Order disbursement.
OrderreportsListDisbursementsResponse
OrderreportsListTransactionsResponse
OrderreportsResource
OrderReportTransaction
OrderReturn
OrderreturnsAcknowledgeRequest
OrderreturnsAcknowledgeResponse
OrderreturnsCreateOrderReturnRequest
OrderreturnsCreateOrderReturnResponse
OrderreturnsLabelsResource
OrderreturnsLineItem
OrderreturnsListResponse
OrderreturnsPartialRefund
OrderreturnsProcessRequest
OrderreturnsProcessResponse
OrderreturnsRefundOperation
OrderreturnsRejectOperation
OrderreturnsResource
OrderreturnsReturnItem
OrdersAcknowledgeRequest
OrdersAcknowledgeResponse
OrdersAdvanceTestOrderResponse
OrdersCancelLineItemRequest
OrdersCancelLineItemResponse
OrdersCancelRequest
OrdersCancelResponse
OrdersCancelTestOrderByCustomerRequest
OrdersCancelTestOrderByCustomerResponse
OrdersCreateTestOrderRequest
OrdersCreateTestOrderResponse
OrdersCreateTestReturnRequest
OrdersCreateTestReturnResponse
OrdersCustomBatchRequestEntryCreateTestReturnReturnItem
OrdersCustomBatchRequestEntryRefundItemItem
OrdersCustomBatchRequestEntryRefundItemShipping
OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo
OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails
ScheduledDeliveryDetails used to update the scheduled delivery order.
OrdersGetByMerchantOrderIdResponse
OrdersGetTestOrderTemplateResponse
OrderShipment
OrderShipmentLineItemShipment
OrderShipmentScheduledDeliveryDetails
OrdersInStoreRefundLineItemRequest
OrdersInStoreRefundLineItemResponse
OrdersListResponse
OrdersRefundItemRequest
OrdersRefundItemResponse
OrdersRefundOrderRequest
OrdersRefundOrderResponse
OrdersRejectReturnLineItemRequest
OrdersRejectReturnLineItemResponse
OrdersResource
OrdersReturnRefundLineItemRequest
OrdersReturnRefundLineItemResponse
OrdersSetLineItemMetadataRequest
OrdersSetLineItemMetadataResponse
OrdersShipLineItemsRequest
OrdersShipLineItemsResponse
OrdersUpdateLineItemShippingDetailsRequest
OrdersUpdateLineItemShippingDetailsResponse
OrdersUpdateMerchantOrderIdRequest
OrdersUpdateMerchantOrderIdResponse
OrdersUpdateShipmentRequest
OrdersUpdateShipmentResponse
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.
OrdertrackingsignalsResource
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
PosResource
PosSale
The change of the available quantity of an item at the given store.
PosSaleRequest
PosSaleResponse
PosStore
Store resource.
PostalCodeGroup
PostalCodeRange
PriceCompetitiveness
Price competitiveness fields requested by the merchant in the query.
PriceInsights
Price insights fields requested by the merchant in the query.
Product
Required product attributes are primarily defined by the product data specification.
ProductAmount
ProductCertification
Product certification, introduced for EU energy efficiency labeling compliance using the EU EPREL database.
ProductCluster
Product cluster fields.
ProductDeliveryTime
The estimated days to deliver a product after an order is placed.
ProductDeliveryTimeAreaDeliveryTime
A pairing of DeliveryArea associated with a DeliveryTime for this product.
ProductDeliveryTimeAreaDeliveryTimeDeliveryTime
A delivery time for this product.
ProductdeliverytimeResource
ProductDimension
ProductId
The Content API ID of the product.
ProductIssue
An issue affecting specific product.
ProductIssueImpact
Overall impact of product issue.
ProductProductDetail
ProductsCustomBatchRequest
ProductsCustomBatchRequestEntry
A batch entry encoding a single non-batch products request.
ProductsCustomBatchResponse
ProductsCustomBatchResponseEntry
A batch entry encoding a single non-batch products response.
ProductShipping
ProductShippingDimension
ProductShippingWeight
ProductsListResponse
ProductsResource
ProductStatus
The status of a product, that is, information about a product computed asynchronously.
ProductStatusDestinationStatus
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
ProductstatusesResource
ProductStatusItemLevelIssue
ProductSubscriptionCost
ProductTax
ProductUnitPricingBaseMeasure
ProductUnitPricingMeasure
ProductView
Product fields.
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
Promotion
Represents a promotion.
PromotionPromotionStatus
The status of the promotion.
PromotionPromotionStatusDestinationStatus
The destination status of the promotion.
PromotionPromotionStatusPromotionIssue
The issue associated with the promotion.
PromotionsResource
PubsubNotificationSettings
Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account.
PubsubnotificationsettingsResource
QuotasResource
RateGroup
Recommendation
Recommendations are suggested ways to improve your merchant account's performance.
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.
RecommendationsResource
RefundReason
Region
Represents a geographic region that you can use as a target with both the RegionalInventory and ShippingSettings services.
RegionalInventory
Regional inventory resource.
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.
RegionalinventoryResource
RegionGeoTargetArea
A list of geotargets that defines the region area.
RegionPostalCodeArea
A list of postal codes that defines the region area.
RegionPostalCodeAreaPostalCodeRange
A range of postal codes that defines the region area.
RegionsResource
RenderAccountIssuesResponse
Response containing support content and actions for listed account issues.
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.
ReportsResource
RequestPhoneVerificationRequest
Request message for the RequestPhoneVerification method.
RequestPhoneVerificationResponse
Response message for the RequestPhoneVerification method.
ReturnAddress
Return address resource.
ReturnAddressAddress
ReturnaddressCustomBatchRequest
ReturnaddressCustomBatchRequestEntry
ReturnaddressCustomBatchResponse
ReturnaddressCustomBatchResponseEntry
ReturnaddressListResponse
ReturnaddressResource
ReturnPolicy
Return policy resource.
ReturnpolicyCustomBatchRequest
ReturnpolicyCustomBatchRequestEntry
ReturnpolicyCustomBatchResponse
ReturnpolicyCustomBatchResponseEntry
ReturnpolicyListResponse
ReturnPolicyOnline
Return policy online object.
ReturnPolicyOnlinePolicy
The available policies.
ReturnpolicyonlineResource
ReturnPolicyOnlineRestockingFee
The restocking fee.
ReturnPolicyOnlineReturnReasonCategoryInfo
The return reason category info wrapper.
ReturnPolicyOnlineReturnShippingFee
The return shipping fee.
ReturnPolicyPolicy
ReturnpolicyResource
ReturnPolicySeasonalOverride
ReturnPricingInfo
ReturnShipment
ReturnShippingLabel
Return shipping label for a Buy on Google merchant-managed return.
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.
Service
ServiceStoreConfig
Stores that provide local delivery.
ServiceStoreConfigCutoffConfig
Time local delivery ends for the day based on the local timezone of the store.
ServiceStoreConfigCutoffConfigLocalCutoffTime
Time in hours and minutes in the local timezone when local delivery ends.
SettlementReport
Settlement reports detail order-level and item-level credits and debits between you and Google.
SettlementreportsListResponse
SettlementreportsResource
SettlementTransaction
Settlement transactions give a detailed breakdown of the settlement report.
SettlementTransactionAmount
SettlementTransactionAmountCommission
SettlementTransactionIdentifiers
SettlementtransactionsListResponse
SettlementtransactionsResource
SettlementTransactionTransaction
ShipmentInvoice
ShipmentInvoiceLineItemInvoice
ShipmentTrackingInfo
ShippingSettings
The merchant account's shipping settings.
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
ShippingsettingsResource
ShoppingadsprogramResource
ShoppingAdsProgramStatus
Response message for GetShoppingAdsProgramStatus.
ShoppingAdsProgramStatusRegionStatus
Status of program and region.
ShoppingContentApi
Manage your product listings and accounts for Google Shopping
Table
TestOrder
TestOrderDeliveryDetails
TestOrderLineItem
TestOrderLineItemProduct
TestOrderPickupDetails
TestOrderPickupDetailsPickupPerson
TimePeriod
A message that represents a time period.
TransitTable
TransitTableTransitTimeRow
TransitTableTransitTimeRowTransitTimeValue
UnitInvoice
UnitInvoiceAdditionalCharge
UnitInvoiceTaxLine
UrlSettings
Specifications related to the Checkout URL.
Value
The single value of a rate group or the value of a rate group table's cell.
VerifyPhoneNumberRequest
Request message for the VerifyPhoneNumber method.
VerifyPhoneNumberResponse
Response message for the VerifyPhoneNumber method.
Warehouse
A fulfillment warehouse, which stores and handles inventory.
WarehouseBasedDeliveryTime
WarehouseCutoffTime
Weight

Typedefs

ActivateBuyOnGoogleProgramRequest = $Empty
Request message for the ActivateProgram method.
CaptureOrderRequest = $Empty
Request message for the CaptureOrder method.
Date = $Date
Represents a whole or partial calendar date, such as a birthday.
FreeListingsProgramStatusReviewIneligibilityReasonDetails = $ProgramStatusReviewIneligibilityReasonDetails
Additional details for review ineligibility reasons.
OrderAddress = $OrderAddress
PauseBuyOnGoogleProgramRequest = $Empty
Request message for the PauseProgram method.
Price = $Shared07
PriceAmount = $Shared07
The price represented as a number and currency.
RenderAccountIssuesRequestPayload = $IssuesRequestPayload
The payload for configuring how the content should be rendered.
RenderProductIssuesRequestPayload = $IssuesRequestPayload
The payload for configuring how the content should be rendered.
RequestReviewBuyOnGoogleProgramRequest = $Empty
Request message for the RequestReviewProgram method.
RequestReviewFreeListingsRequest = $Request07
Request message for the RequestReviewFreeListings Program method.
RequestReviewShoppingAdsRequest = $Request07
Request message for the RequestReviewShoppingAds program method.
ShoppingAdsProgramStatusReviewIneligibilityReasonDetails = $ProgramStatusReviewIneligibilityReasonDetails
Additional details for review ineligibility reasons.
TestOrderAddress = $OrderAddress
TimeZone = $TimeZone
Represents a time zone from the IANA Time Zone Database.
UndeleteConversionSourceRequest = $Empty
Request message for the UndeleteConversionSource method.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.