Show / Hide Table of Contents

Namespace Google.Apis.ShoppingContent.v2_1

Classes

AccountsResource

The "accounts" collection of methods.

AccountsResource.AuthinfoRequest

Returns information about the authenticated user.

AccountsResource.ClaimwebsiteRequest

Claims the website of a Merchant Center sub-account.

AccountsResource.CredentialsResource

The "credentials" collection of methods.

AccountsResource.CredentialsResource.CreateRequest

Uploads credentials for the Merchant Center account. If credentials already exist for this Merchant Center account and purpose, this method updates them.

AccountsResource.CustombatchRequest

Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.

AccountsResource.DeleteRequest

Deletes a Merchant Center sub-account.

AccountsResource.GetRequest

Retrieves a Merchant Center account.

AccountsResource.InsertRequest

Creates a Merchant Center sub-account.

AccountsResource.LabelsResource

The "labels" collection of methods.

AccountsResource.LabelsResource.CreateRequest

Creates a new label, not assigned to any account.

AccountsResource.LabelsResource.DeleteRequest

Deletes a label and removes it from all accounts to which it was assigned.

AccountsResource.LabelsResource.ListRequest

Lists the labels assigned to an account.

AccountsResource.LabelsResource.PatchRequest

Updates a label.

AccountsResource.LinkRequest

Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.

AccountsResource.ListlinksRequest

Returns the list of accounts linked to your Merchant Center account.

AccountsResource.ListRequest

Lists the sub-accounts in your Merchant Center account.

AccountsResource.RequestphoneverificationRequest

Request verification code to start phone verification.

AccountsResource.ReturncarrierResource

The "returncarrier" collection of methods.

AccountsResource.ReturncarrierResource.CreateRequest

Links return carrier to a merchant account.

AccountsResource.ReturncarrierResource.DeleteRequest

Delete a return carrier in the merchant account.

AccountsResource.ReturncarrierResource.ListRequest

Lists available return carriers in the merchant account.

AccountsResource.ReturncarrierResource.PatchRequest

Updates a return carrier in the merchant account.

AccountsResource.UpdatelabelsRequest

Updates labels that are assigned to the Merchant Center account by CSS user.

AccountsResource.UpdateRequest

Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.

AccountsResource.VerifyphonenumberRequest

Validates verification code to verify phone number for the account. If successful this will overwrite the value of accounts.businessinformation.phoneNumber. Only verified phone number will replace an existing verified phone number.

AccountstatusesResource

The "accountstatuses" collection of methods.

AccountstatusesResource.CustombatchRequest

Retrieves multiple Merchant Center account statuses in a single request.

AccountstatusesResource.GetRequest

Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.

AccountstatusesResource.ListRequest

Lists the statuses of the sub-accounts in your Merchant Center account.

AccounttaxResource

The "accounttax" collection of methods.

AccounttaxResource.CustombatchRequest

Retrieves and updates tax settings of multiple accounts in a single request.

AccounttaxResource.GetRequest

Retrieves the tax settings of the account.

AccounttaxResource.ListRequest

Lists the tax settings of the sub-accounts in your Merchant Center account.

AccounttaxResource.UpdateRequest

Updates the tax settings of the account. Any fields that are not provided are deleted from the resource.

BuyongoogleprogramsResource

The "buyongoogleprograms" collection of methods.

BuyongoogleprogramsResource.ActivateRequest

Reactivates the BoG program in your Merchant Center account. Moves the program to the active state when allowed, for example, when paused. This method is only available to selected merchants.

BuyongoogleprogramsResource.GetRequest

Retrieves a status of the BoG program for your Merchant Center account.

BuyongoogleprogramsResource.OnboardRequest

Onboards the BoG program in your Merchant Center account. By using this method, you agree to the Terms of Service. Calling this method is only possible if the authenticated account is the same as the merchant id in the request. Calling this method multiple times will only accept Terms of Service if the latest version is not currently signed.

BuyongoogleprogramsResource.PatchRequest

Updates the status of the BoG program for your Merchant Center account.

BuyongoogleprogramsResource.PauseRequest

Pauses the BoG program in your Merchant Center account. This method is only available to selected merchants.

BuyongoogleprogramsResource.RequestreviewRequest

Requests review and then activates the BoG program in your Merchant Center account for the first time. Moves the program to the REVIEW_PENDING state. This method is only available to selected merchants.

CollectionsResource

The "collections" collection of methods.

CollectionsResource.CreateRequest

Uploads a collection to your Merchant Center account. If a collection with the same collectionId already exists, this method updates that entry. In each update, the collection is completely replaced by the fields in the body of the update request.

CollectionsResource.DeleteRequest

Deletes a collection from your Merchant Center account.

CollectionsResource.GetRequest

Retrieves a collection from your Merchant Center account.

CollectionsResource.ListRequest

Lists the collections in your Merchant Center account. The response might contain fewer items than specified by page_size. Rely on next_page_token to determine if there are more items to be requested.

CollectionstatusesResource

The "collectionstatuses" collection of methods.

CollectionstatusesResource.GetRequest

Gets the status of a collection from your Merchant Center account.

CollectionstatusesResource.ListRequest

Lists the statuses of the collections in your Merchant Center account.

CssesResource

The "csses" collection of methods.

CssesResource.GetRequest

Retrieves a single CSS domain by ID.

CssesResource.ListRequest

Lists CSS domains affiliated with a CSS group.

CssesResource.UpdatelabelsRequest

Updates labels that are assigned to a CSS domain by its CSS group.

DatafeedsResource

The "datafeeds" collection of methods.

DatafeedsResource.CustombatchRequest

Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.

DatafeedsResource.DeleteRequest

Deletes a datafeed configuration from your Merchant Center account.

DatafeedsResource.FetchnowRequest

Invokes a fetch for the datafeed in your Merchant Center account. If you need to call this method more than once per day, we recommend you use the Products service to update your product data.

DatafeedsResource.GetRequest

Retrieves a datafeed configuration from your Merchant Center account.

DatafeedsResource.InsertRequest

Registers a datafeed configuration with your Merchant Center account.

DatafeedsResource.ListRequest

Lists the configurations for datafeeds in your Merchant Center account.

DatafeedsResource.UpdateRequest

Updates a datafeed configuration of your Merchant Center account. Any fields that are not provided are deleted from the resource.

DatafeedstatusesResource

The "datafeedstatuses" collection of methods.

DatafeedstatusesResource.CustombatchRequest

Gets multiple Merchant Center datafeed statuses in a single request.

DatafeedstatusesResource.GetRequest

Retrieves the status of a datafeed from your Merchant Center account.

DatafeedstatusesResource.ListRequest

Lists the statuses of the datafeeds in your Merchant Center account.

FreelistingsprogramResource

The "freelistingsprogram" collection of methods.

FreelistingsprogramResource.GetRequest

Retrieves the status and review eligibility for the free listing program. Returns errors and warnings if they require action to resolve, will become disapprovals, or impact impressions. Use accountstatuses to view all issues for an account.

FreelistingsprogramResource.RequestreviewRequest

Requests a review of free listings in a specific region. This method is only available to selected merchants.

LiasettingsResource

The "liasettings" collection of methods.

LiasettingsResource.CustombatchRequest

Retrieves and/or updates the LIA settings of multiple accounts in a single request.

LiasettingsResource.GetaccessiblegmbaccountsRequest

Retrieves the list of accessible Business Profiles.

LiasettingsResource.GetRequest

Retrieves the LIA settings of the account.

LiasettingsResource.ListposdataprovidersRequest

Retrieves the list of POS data providers that have active settings for the all eiligible countries.

LiasettingsResource.ListRequest

Lists the LIA settings of the sub-accounts in your Merchant Center account.

LiasettingsResource.RequestgmbaccessRequest

Requests access to a specified Business Profile.

LiasettingsResource.RequestinventoryverificationRequest

Requests inventory validation for the specified country.

LiasettingsResource.SetinventoryverificationcontactRequest

Sets the inventory verification contract for the specified country.

LiasettingsResource.SetposdataproviderRequest

Sets the POS data provider for the specified country.

LiasettingsResource.UpdateRequest

Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource.

LocalinventoryResource

The "localinventory" collection of methods.

LocalinventoryResource.CustombatchRequest

Updates local inventory for multiple products or stores in a single request.

LocalinventoryResource.InsertRequest

Updates the local inventory of a product in your Merchant Center account.

OrderinvoicesResource

The "orderinvoices" collection of methods.

OrderinvoicesResource.CreatechargeinvoiceRequest

Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.

OrderinvoicesResource.CreaterefundinvoiceRequest

Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using createChargeInvoice. All amounts (except for the summary) are incremental with respect to the previous invoice.

OrderreportsResource

The "orderreports" collection of methods.

OrderreportsResource.ListdisbursementsRequest

Retrieves a report for disbursements from your Merchant Center account.

OrderreportsResource.ListtransactionsRequest

Retrieves a list of transactions for a disbursement from your Merchant Center account.

OrderreturnsResource

The "orderreturns" collection of methods.

OrderreturnsResource.AcknowledgeRequest

Acks an order return in your Merchant Center account.

OrderreturnsResource.CreateorderreturnRequest

Create return in your Merchant Center account.

OrderreturnsResource.GetRequest

Retrieves an order return from your Merchant Center account.

OrderreturnsResource.LabelsResource

The "labels" collection of methods.

OrderreturnsResource.LabelsResource.CreateRequest

Links a return shipping label to a return id. You can only create one return label per return id. Since the label is sent to the buyer, the linked return label cannot be updated or deleted. If you try to create multiple return shipping labels for a single return id, every create request except the first will fail.

OrderreturnsResource.ListRequest

Lists order returns in your Merchant Center account.

OrderreturnsResource.ProcessRequest

Processes return in your Merchant Center account.

OrdersResource

The "orders" collection of methods.

OrdersResource.AcknowledgeRequest

Marks an order as acknowledged.

OrdersResource.AdvancetestorderRequest

Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment".

OrdersResource.CancellineitemRequest

Cancels a line item, making a full refund.

OrdersResource.CancelRequest

Cancels all line items in an order, making a full refund.

OrdersResource.CanceltestorderbycustomerRequest

Sandbox only. Cancels a test order for customer-initiated cancellation.

OrdersResource.CaptureOrderRequest

Capture funds from the customer for the current order total. This method should be called after the merchant verifies that they are able and ready to start shipping the order. This method blocks until a response is received from the payment processsor. If this method succeeds, the merchant is guaranteed to receive funds for the order after shipment. If the request fails, it can be retried or the order may be cancelled. This method cannot be called after the entire order is already shipped. A rejected error code is returned when the payment service provider has declined the charge. This indicates a problem between the PSP and either the merchant's or customer's account. Sometimes this error will be resolved by the customer. We recommend retrying these errors once per day or cancelling the order with reason failedToCaptureFunds if the items cannot be held.

OrdersResource.CreatetestorderRequest

Sandbox only. Creates a test order.

OrdersResource.CreatetestreturnRequest

Sandbox only. Creates a test return.

OrdersResource.GetbymerchantorderidRequest

Retrieves an order using merchant order ID.

OrdersResource.GetRequest

Retrieves an order from your Merchant Center account.

OrdersResource.GettestordertemplateRequest

Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.

OrdersResource.InstorerefundlineitemRequest

Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (for example, cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding through Google then through an in-store return.

OrdersResource.ListRequest

Lists the orders in your Merchant Center account.

OrdersResource.RefunditemRequest

Issues a partial or total refund for items and shipment.

OrdersResource.RefundorderRequest

Issues a partial or total refund for an order.

OrdersResource.RejectreturnlineitemRequest

Rejects return on an line item.

OrdersResource.ReturnrefundlineitemRequest

Returns and refunds a line item. Note that this method can only be called on fully shipped orders. The Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.

OrdersResource.SetlineitemmetadataRequest

Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided through other methods. Submitted key-value pairs can be retrieved as part of the orders resource.

OrdersResource.ShiplineitemsRequest

Marks line item(s) as shipped.

OrdersResource.UpdatelineitemshippingdetailsRequest

Updates ship by and delivery by dates for a line item.

OrdersResource.UpdatemerchantorderidRequest

Updates the merchant order ID for a given order.

OrdersResource.UpdateshipmentRequest

Updates a shipment's status, carrier, and/or tracking ID.

OrdertrackingsignalsResource

The "ordertrackingsignals" collection of methods.

OrdertrackingsignalsResource.CreateRequest

Creates new order tracking signal.

PosResource

The "pos" collection of methods.

PosResource.CustombatchRequest

Batches multiple POS-related calls in a single request.

PosResource.DeleteRequest

Deletes a store for the given merchant.

PosResource.GetRequest

Retrieves information about the given store.

PosResource.InsertRequest

Creates a store for the given merchant.

PosResource.InventoryRequest

Submit inventory for the given merchant.

PosResource.ListRequest

Lists the stores of the target merchant.

PosResource.SaleRequest

Submit a sale event for the given merchant.

ProductdeliverytimeResource

The "productdeliverytime" collection of methods.

ProductdeliverytimeResource.CreateRequest

Creates or updates the delivery time of a product.

ProductdeliverytimeResource.DeleteRequest

Deletes the delivery time of a product.

ProductdeliverytimeResource.GetRequest

Gets productDeliveryTime by productId.

ProductsResource

The "products" collection of methods.

ProductsResource.CustombatchRequest

Retrieves, inserts, and deletes multiple products in a single request.

ProductsResource.DeleteRequest

Deletes a product from your Merchant Center account.

ProductsResource.GetRequest

Retrieves a product from your Merchant Center account.

ProductsResource.InsertRequest

Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry.

ProductsResource.ListRequest

Lists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested.

ProductsResource.UpdateRequest

Updates an existing product in your Merchant Center account. Only updates attributes provided in the request.

ProductstatusesResource

The "productstatuses" collection of methods.

ProductstatusesResource.CustombatchRequest

Gets the statuses of multiple products in a single request.

ProductstatusesResource.GetRequest

Gets the status of a product from your Merchant Center account.

ProductstatusesResource.ListRequest

Lists the statuses of the products in your Merchant Center account.

ProductstatusesResource.RepricingreportsResource

The "repricingreports" collection of methods.

ProductstatusesResource.RepricingreportsResource.ListRequest

Lists the metrics report for a given Repricing product.

PromotionsResource

The "promotions" collection of methods.

PromotionsResource.CreateRequest

Inserts a promotion for your Merchant Center account. If the promotion already exists, then it updates the promotion instead. To end or delete a promotion update the time period of the promotion to a time that has already passed.

PromotionsResource.GetRequest

Retrieves a promotion from your Merchant Center account.

PubsubnotificationsettingsResource

The "pubsubnotificationsettings" collection of methods.

PubsubnotificationsettingsResource.GetRequest

Retrieves a Merchant Center account's pubsub notification settings.

PubsubnotificationsettingsResource.UpdateRequest

Register a Merchant Center account for pubsub notifications. Note that cloud topic name shouldn't be provided as part of the request.

QuotasResource

The "quotas" collection of methods.

QuotasResource.ListRequest

Lists the daily call quota and usage per method for your Merchant Center account.

RegionalinventoryResource

The "regionalinventory" collection of methods.

RegionalinventoryResource.CustombatchRequest

Updates regional inventory for multiple products or regions in a single request.

RegionalinventoryResource.InsertRequest

Updates the regional inventory of a product in your Merchant Center account. If a regional inventory with the same region ID already exists, this method updates that entry.

RegionsResource

The "regions" collection of methods.

RegionsResource.CreateRequest

Creates a region definition in your Merchant Center account.

RegionsResource.DeleteRequest

Deletes a region definition from your Merchant Center account.

RegionsResource.GetRequest

Retrieves a region defined in your Merchant Center account.

RegionsResource.ListRequest

Lists the regions in your Merchant Center account.

RegionsResource.PatchRequest

Updates a region definition in your Merchant Center account.

ReportsResource

The "reports" collection of methods.

ReportsResource.SearchRequest

Retrieves merchant performance mertrics matching the search query and optionally segmented by selected dimensions.

RepricingrulesResource

The "repricingrules" collection of methods.

RepricingrulesResource.CreateRequest

Creates a repricing rule for your Merchant Center account.

RepricingrulesResource.DeleteRequest

Deletes a repricing rule in your Merchant Center account.

RepricingrulesResource.GetRequest

Retrieves a repricing rule from your Merchant Center account.

RepricingrulesResource.ListRequest

Lists the repricing rules in your Merchant Center account.

RepricingrulesResource.PatchRequest

Updates a repricing rule in your Merchant Center account. All mutable fields will be overwritten in each update request. In each update, you must provide all required mutable fields, or an error will be thrown. If you do not provide an optional field in the update request, if that field currently exists, it will be deleted from the rule.

RepricingrulesResource.RepricingreportsResource

The "repricingreports" collection of methods.

RepricingrulesResource.RepricingreportsResource.ListRequest

Lists the metrics report for a given Repricing rule.

ReturnaddressResource

The "returnaddress" collection of methods.

ReturnaddressResource.CustombatchRequest

Batches multiple return address related calls in a single request.

ReturnaddressResource.DeleteRequest

Deletes a return address for the given Merchant Center account.

ReturnaddressResource.GetRequest

Gets a return address of the Merchant Center account.

ReturnaddressResource.InsertRequest

Inserts a return address for the Merchant Center account.

ReturnaddressResource.ListRequest

Lists the return addresses of the Merchant Center account.

ReturnpolicyonlineResource

The "returnpolicyonline" collection of methods.

ReturnpolicyonlineResource.CreateRequest

Creates a new return policy.

ReturnpolicyonlineResource.DeleteRequest

Deletes an existing return policy.

ReturnpolicyonlineResource.GetRequest

Gets an existing return policy.

ReturnpolicyonlineResource.ListRequest

Lists all existing return policies.

ReturnpolicyonlineResource.PatchRequest

Updates an existing return policy.

ReturnpolicyResource

The "returnpolicy" collection of methods.

ReturnpolicyResource.CustombatchRequest

Batches multiple return policy related calls in a single request.

ReturnpolicyResource.DeleteRequest

Deletes a return policy for the given Merchant Center account.

ReturnpolicyResource.GetRequest

Gets a return policy of the Merchant Center account.

ReturnpolicyResource.InsertRequest

Inserts a return policy for the Merchant Center account.

ReturnpolicyResource.ListRequest

Lists the return policies of the Merchant Center account.

SettlementreportsResource

The "settlementreports" collection of methods.

SettlementreportsResource.GetRequest

Retrieves a settlement report from your Merchant Center account.

SettlementreportsResource.ListRequest

Retrieves a list of settlement reports from your Merchant Center account.

SettlementtransactionsResource

The "settlementtransactions" collection of methods.

SettlementtransactionsResource.ListRequest

Retrieves a list of transactions for the settlement.

ShippingsettingsResource

The "shippingsettings" collection of methods.

ShippingsettingsResource.CustombatchRequest

Retrieves and updates the shipping settings of multiple accounts in a single request.

ShippingsettingsResource.GetRequest

Retrieves the shipping settings of the account.

ShippingsettingsResource.GetsupportedcarriersRequest

Retrieves supported carriers and carrier services for an account.

ShippingsettingsResource.GetsupportedholidaysRequest

Retrieves supported holidays for an account.

ShippingsettingsResource.GetsupportedpickupservicesRequest

Retrieves supported pickup services for an account.

ShippingsettingsResource.ListRequest

Lists the shipping settings of the sub-accounts in your Merchant Center account.

ShippingsettingsResource.UpdateRequest

Updates the shipping settings of the account. Any fields that are not provided are deleted from the resource.

ShoppingadsprogramResource

The "shoppingadsprogram" collection of methods.

ShoppingadsprogramResource.GetRequest

Retrieves the status and review eligibility for the Shopping Ads program. Returns errors and warnings if they require action to resolve, will become disapprovals, or impact impressions. Use accountstatuses to view all issues for an account.

ShoppingadsprogramResource.RequestreviewRequest

Requests a review of Shopping ads in a specific region. This method is only available to selected merchants.

ShoppingContentBaseServiceRequest<TResponse>

A base abstract class for ShoppingContent requests.

ShoppingContentService

The ShoppingContent Service.

ShoppingContentService.Scope

Available OAuth 2.0 scopes for use with the Content API for Shopping.

ShoppingContentService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Content API for Shopping.

Enums

AccountsResource.GetRequest.ViewEnum

Controls which fields will be populated. Acceptable values are: "merchant" and "css". The default value is "merchant".

AccountsResource.ListRequest.ViewEnum

Controls which fields will be populated. Acceptable values are: "merchant" and "css". The default value is "merchant".

OrderreturnsResource.ListRequest.OrderByEnum

Return the results in the specified order.

OrderreturnsResource.ListRequest.ShipmentStatesEnum

Obtains order returns that match any shipment state provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment states.

OrderreturnsResource.ListRequest.ShipmentStatusEnum

Obtains order returns that match any shipment status provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment statuses.

OrderreturnsResource.ListRequest.ShipmentTypesEnum

Obtains order returns that match any shipment type provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment types.

OrdersResource.GettestordertemplateRequest.TemplateNameEnum

The name of the template to retrieve.

OrdersResource.ListRequest.StatusesEnum

Obtains orders that match any of the specified statuses. Note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped, partiallyDelivered, delivered, partiallyReturned, returned, and canceled.

ShoppingContentBaseServiceRequest<TResponse>.AltEnum

Data format for response.

ShoppingContentBaseServiceRequest<TResponse>.XgafvEnum

V1 error format.

In This Article
Back to top Generated by DocFX