About the Google Merchant category

Alumio_Bot · November 22, 2023, 9:52am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation:

Connector package documentation

Setting up HTTP Client Google Merchant

Steps

In Alumio Dashboard, go to Clients > HTTP Clients. Create a new HTTP Client and select Google Merchant HTTP Client as the prototype of the HTTP Client.
Fill in the Base URI, Client ID, Client Secret, Code, and Scopes (optional).
Press “Grant access to Google Merchant Center” and save.

Subscribing to Entities from Google Merchant

Steps

Go to Connections → Incoming and create a new incoming configuration and select Google Merchant Subscriber as the subscriber.
Select the entity you want to subscribe from Google Merchant.
Add any request parameters needed to subscribe to the entity (optional).
You can optionally add a transformer to transform the request parameters into something you need.
Select the Google Merchant HTTP Client to use.

General Concept

We follow Google Merchant documentation on building this connector so you can easily use the connector based on Google Merchant API Reference.

Entity
It’s the entity you want to subscribe from Google Merchant. Please refer to the entities in Management APIs from the Google Merchant API Reference page.

Request Parameters
These are the parameters you can provide to get the needed entity based on Google Merchant API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing to accounts.get entity.

That’s why we need to define merchantId and accountId properties inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on accounts.get entity.

/content/v2.1/1/accounts/1

Input Transformer
Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity.

HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Google Merchant.

Publishing Entity to Google Merchant

Steps

Go to Connections → Outgoing, create a new outgoing configuration, and select Google Merchant Publisher as the publisher.
Select the action that you want the publisher to do with the data.
Select the Google Merchant entity you want the data to be published.
Select the HTTP Client to use.

General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration).

Action
Currently, we support Create (HTTP POST method), Put (HTTP PUT method),Patch (HTTP PATCH method), and Delete (HTTP DELETE method).

Entity
We support publishing to most Google Merchant endpoints. Please refer to the entities in Management APIs from the Google Merchant API Reference page. Based on the documentation, some endpoints may need one or more path parameters.

For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create a Accounts. Please select “Create” as the action and “accounts. insert” as the entity of the publisher.

You can put the payload you want to send to Google Merchant into the payload property in the data.

Alumio will send an API request to Google Merchant with URL /content/v2.1/1/accounts

HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Google Merchant.

Important Notes

Documentation Mistake

Product insert: the parameter “offerId” is needed and this is not mentioned in the documentation. Also the documentation mentions that we should insert the parameters in this format for example: “image_link” but it should be “imageLink” and for example the as per the documentation it says “is_bundle” but the parameter should be “isBundle”. This goes for all parameters.
Create Region: The payload should have the following parameters unlike the documentation

{
  "displayname": "TestRegion_Alumio",
  "postalCodeArea": {
    "regionCode": "US",
    "postalCodes": [
      {
        "end": "98112",
        "begin": "98064"
      }
    ]
  },
  "shippingEligible" : true,
  "regionalInventoryEligible" : true
}