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 is fully operational. The methods delete, insert, and update require the admin role.

AccountCredentials

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

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.

AccountsCustomBatchRequestEntry

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

AccountsCustomBatchRequestEntryLinkRequest

AccountsCustomBatchResponseEntry

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

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.

AccountTax

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

AccounttaxCustomBatchRequestEntry

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

AccounttaxCustomBatchResponseEntry

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

AccountTaxTaxRule

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

ActivateBuyOnGoogleProgramRequest

Request message for the ActivateProgram method.

BuyOnGoogleProgramStatus

Response message for the GetProgramStatus method.

CollectionFeaturedProduct

The message for FeaturedProduct. FeaturedProduct

CollectionStatusDestinationStatus

Destination status message.

CollectionStatusItemLevelIssue

Issue associated with the collection.

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

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

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

DatafeedStatusExample

An example occurrence for a particular error.

DatafeedTarget

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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and 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 is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values. 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.

DeliveryTime

Error

An error returned by the API.

Errors

A list of errors returned by a failed batch entry.

GmbAccounts

GmbAccountsGmbAccount

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

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. All methods except listposdataproviders require the admin role.

LiasettingsCustomBatchRequest

LiasettingsCustomBatchRequestEntry

LiasettingsCustomBatchResponse

LiasettingsCustomBatchResponseEntry

LiasettingsGetAccessibleGmbAccountsResponse

LiasettingsListPosDataProvidersResponse

LiasettingsListResponse

LiasettingsRequestGmbAccessResponse

LiasettingsRequestInventoryVerificationResponse

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

LoyaltyPoints

MerchantOrderReturn

Order return. Production access (all methods) requires the order manager role. Sandbox access does not.

MerchantOrderReturnItem

MerchantRejectionReason

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.

MonetaryAmount

OnboardBuyOnGoogleProgramRequest

Request message for the OnboardProgram method.

Order

Order. Production access (all methods) requires the order manager role. Sandbox access does not.

OrderAddress

OrderCancellation

OrderCustomer

OrderCustomerLoyaltyInfo

OrderCustomerMarketingRightsInfo

OrderDeliveryDetails

OrderinvoicesCreateChargeInvoiceRequest

OrderinvoicesCreateChargeInvoiceResponse

OrderinvoicesCreateRefundInvoiceRequest

OrderinvoicesCreateRefundInvoiceResponse

OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption

OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption

OrderLineItem

OrderLineItemAdjustment

OrderLineItemProduct

OrderLineItemProductFee

OrderLineItemProductVariantAttribute

OrderLineItemReturnInfo

OrderLineItemShippingDetails

OrderLineItemShippingDetailsMethod

OrderMerchantProvidedAnnotation

OrderOrderAnnotation

OrderPickupDetails

OrderPickupDetailsCollector

OrderPromotion

OrderPromotionItem

OrderRefund

OrderReportDisbursement

Order disbursement. All methods require the payment analyst role.

OrderreportsListDisbursementsResponse

OrderreportsListTransactionsResponse

OrderReportTransaction

OrderReturn

OrderreturnsAcknowledgeRequest

OrderreturnsAcknowledgeResponse

OrderreturnsCreateOrderReturnRequest

OrderreturnsCreateOrderReturnResponse

OrderreturnsLineItem

OrderreturnsListResponse

OrderreturnsPartialRefund

OrderreturnsProcessRequest

OrderreturnsProcessResponse

OrderreturnsRefundOperation

OrderreturnsRejectOperation

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

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.

PauseBuyOnGoogleProgramRequest

Request message for the PauseProgram method.

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.

Product

Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Some attributes are country-specific, so make sure you select the appropriate country in the drop-down selector at the top of the page. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.

ProductAmount

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

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

ProductStatusItemLevelIssue

ProductSubscriptionCost

ProductTax

ProductUnitPricingBaseMeasure

ProductUnitPricingMeasure

PubsubNotificationSettings

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

RateGroup

RefundReason

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.

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.

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.

ReportRow

Result row returned from the search query.

RepricingProductReport

Resource that represents a daily Repricing product report. Each report contains stats for a single type of Repricing rule for a single product on a given day. If there are multiple rules of the same type for the product on that day, the report lists all the rules by rule ids, combines the stats, and paginates the results by date. To retrieve the stats of a particular rule, provide the rule_id in the request.

RepricingProductReportBuyboxWinningProductStats

Stats specific to buybox winning rules for product report.

RepricingRule

Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met. Next ID: 24

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. When the USE_FEED_ATTRIBUTE option is selected, only the repricing_rule_id attribute on the product feed is used to specify offer-rule mapping. When the CUSTOM_FILTER option is selected, only the *_matcher fields are used to filter the offers for offer-rule mapping. If the CUSTOM_FILTER option is selected, an offer needs to satisfy each custom filter matcher to be eligible for a rule. Size limit: the sum of the number of entries in all the matchers should not exceed 20. For example, there can be 15 product ids and 5 brands, but not 10 product ids and 11 brands.

RepricingRuleEligibleOfferMatcherStringMatcher

Matcher by string attributes.

RepricingRuleReport

Resource that represents a daily Repricing rule report. Next ID: 11

RepricingRuleReportBuyboxWinningRuleStats

Stats specific to buybox winning rules for rule report.

RepricingRuleRestriction

Definition of a rule restriction. At least one of the following needs to be true: (1) use_auto_pricing_min_price is true (2) floor.price_delta exists (3) floor.percentage_delta exists If floor.price_delta and floor.percentage_delta are both set on a rule, the highest value will be chosen by the Repricer. In other words, for a product with a price of $50, if the floor.percentage_delta is "-10" and the floor.price_delta is "-12", the offer price will only be lowered $5 (10% lower than the original offer price).

RepricingRuleRestrictionBoundary

Definition of a boundary.

RepricingRuleStatsBasedRule

Definition of stats based rule.

RequestReviewBuyOnGoogleProgramRequest

Request message for the RequestReviewProgram method.

ReturnAddress

Return address resource.

ReturnAddressAddress

ReturnaddressCustomBatchRequest

ReturnaddressCustomBatchRequestEntry

ReturnaddressCustomBatchResponse

ReturnaddressCustomBatchResponseEntry

ReturnaddressListResponse

ReturnPolicy

Return policy resource.

ReturnpolicyCustomBatchRequest

ReturnpolicyCustomBatchRequestEntry

ReturnpolicyCustomBatchResponse

ReturnpolicyCustomBatchResponseEntry

ReturnpolicyListResponse

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

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. Values of product dimensions, e.g., offer id, reflect the state of a product at the time of the corresponding event, e.g., 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.