content.v2_1 library Null safety

Content API for Shopping - v2.1

Manage your product listings and accounts for Google Shopping

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

Create an instance of ShoppingContentApi to access these resources:

Classes

Account
Account data. [...]
AccountAddress
AccountBusinessInformation
AccountCredentials
Credentials allowing Google to call a partner's API on behalf of a merchant.
AccountCustomerService
AccountIdentifier
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.
AccountsLabelsResource
AccountsLinkRequest
AccountsLinkResponse
AccountsListLinksResponse
AccountsListResponse
AccountsResource
AccountsReturncarrierResource
AccountStatus
The status of an account, i.e., 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 (USA only).
AccountUser
Address
Amount
BusinessDayConfig
BuyongoogleprogramsResource
BuyOnGoogleProgramStatus
Response message for the GetProgramStatus method.
CaptureOrderResponse
Response message for the CaptureOrder method.
CarrierRate
CarriersCarrier
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.
Css
Information about CSS domain.
CssesResource
CustomAttribute
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, i.e., 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). [...]
DeliveryTime
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.
FreelistingsprogramResource
FreeListingsProgramStatus
Response message for GetFreeListingsProgramStatus.
FreeListingsProgramStatusRegionStatus
Status of program and region.
GmbAccounts
GmbAccountsGmbAccount
Headers
A non-empty list of row or column headers for a table. [...]
HolidayCutoff
HolidaysHoliday
InapplicabilityDetails
Map of inapplicability details.
Installment
InvoiceSummary
InvoiceSummaryAdditionalChargeSummary
LabelIds
The IDs of labels that should be assigned to the CSS domain.
LiaAboutPageSettings
LiaCountrySettings
LiaInventorySettings
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.
ListCssesResponse
The response message for the ListCsses method
ListRegionsResponse
Response message for the ListRegions method.
ListRepricingProductReportsResponse
Response message for the ListRepricingProductReports method.
ListRepricingRuleReportsResponse
Response message for the ListRepricingRuleReports method.
ListRepricingRulesResponse
Response message for the ListRepricingRules 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
MerchantOrderReturn
Order return. [...]
MerchantOrderReturnItem
MerchantRejectionReason
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
Product
Required product attributes are primarily defined by the products data specification. [...]
ProductAmount
ProductDimension
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, i.e., 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
ProductstatusesRepricingreportsResource
ProductstatusesResource
ProductStatusItemLevelIssue
ProductSubscriptionCost
ProductTax
ProductUnitPricingBaseMeasure
ProductUnitPricingMeasure
ProductWeight
Promotion
The Promotions feature is currently in alpha and is not yet publicly available via Content API for Shopping. [...]
PromotionsResource
PubsubNotificationSettings
Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account.
PubsubnotificationsettingsResource
RateGroup
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
ReportRow
Result row returned from the search query.
ReportsResource
RepricingProductReport
Resource that represents a daily Repricing product report. [...]
RepricingProductReportBuyboxWinningProductStats
Stats specific to buybox winning rules for product report.
RepricingRule
Represents a repricing rule. [...]
RepricingRuleCostOfGoodsSaleRule
A repricing rule that changes the sale price based on cost of goods sale.
RepricingRuleEffectiveTime
RepricingRuleEffectiveTimeFixedTimePeriod
Definition of a fixed time period.
RepricingRuleEligibleOfferMatcher
Matcher that specifies eligible offers. [...]
RepricingRuleEligibleOfferMatcherStringMatcher
Matcher by string attributes.
RepricingRuleReport
Resource that represents a daily Repricing rule report. [...]
RepricingRuleReportBuyboxWinningRuleStats
Stats specific to buybox winning rules for rule report.
RepricingRuleRestriction
Definition of a rule restriction. [...]
RepricingRuleRestrictionBoundary
Definition of a boundary.
RepricingrulesRepricingreportsResource
RepricingrulesResource
RepricingRuleStatsBasedRule
Definition of stats based rule.
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
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
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. [...]
OrderAddress = $OrderAddress
PauseBuyOnGoogleProgramRequest = $Empty
Request message for the PauseProgram method.
Price = $Shared07
PriceAmount = $Shared07
The price represented as a number and currency.
RequestReviewBuyOnGoogleProgramRequest = $Empty
Request message for the RequestReviewProgram method.
RequestReviewFreeListingsRequest = $Request06
Request message for the RequestReviewFreeListings Program method.
RequestReviewShoppingAdsRequest = $Request06
Request message for the RequestReviewShoppingAds program method.
TestOrderAddress = $OrderAddress
TimeZone = $TimeZone
Represents a time zone from the IANA Time Zone Database.

Exceptions / Errors

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