In diesem Abschnitt wird beschrieben, wie Sie zeitkritische Aktualisierungen Ihrer Inventarentitäten an Google senden können. Mit der API für Echtzeit-Updates können Sie Aktualisierungen übertragen und Entitäten nahezu in Echtzeit in Ihrem Sandbox- oder Produktionsinventar löschen.
Diese Funktion ist hauptsächlich für Aktualisierungen vorgesehen, die nicht vorhersehbar sind. Dazu gehören z. B. Notfallschließungen, das Entfernen von Speisen aus der Speisekarte oder das Aktualisieren des Preises eines Speisenangebots, was schnell in der Google-Benutzeroberfläche angezeigt werden muss. Wenn Ihre Änderung nicht sofort wirksam werden muss, können Sie stattdessen die Batchaufnahme verwenden. Aktualisierungen in Echtzeit werden in höchstens fünf Minuten verarbeitet.
Voraussetzungen
Die folgenden Punkte sind erforderlich, bevor Sie Echtzeitaktualisierungen implementieren:
Die Maps Booking API ist aktiviert:
Gehen Sie in der GCP zu APIs und Dienste > Bibliothek.
Suchen Sie nach „Google Maps Booking API“.
Suche nach der Sandbox-Instanz („Google Maps Booking API (Dev)“) und klicke auf Aktivieren.
Suche nach der Produktionsinstanz („Google Maps Booking API“) und klicke auf Aktivieren.
Es wird ein Dienstkonto mit der Bearbeiterrolle für Ihr GCP-Projekt erstellt. Weitere Informationen finden Sie unter Kontoeinrichtung.
Produktions- oder Sandbox-Datenfeeds werden gehostet und aufgenommen. Weitere Informationen finden Sie unter Batch-Aufnahme.
Für die API-Authentifizierung wird empfohlen, die Google-Clientbibliothek in der Sprache Ihrer Wahl zu installieren. Verwenden Sie als OAuth-Bereich „https://www.googleapis.com/auth/mapsbooking“. Diese Bibliotheken werden in den unten aufgeführten Codebeispielen verwendet. Andernfalls müssen Sie den Tokenaustausch manuell ausführen, wie unter OAuth 2.0 für den Zugriff auf Google APIs verwenden beschrieben.
Überblick
Die Echtzeit-Updates-API unterstützt zwei Arten von Vorgängen. Der erste Vorgang ist Upsert zum Aktualisieren vorhandener Entitäten. Der zweite Vorgang ist das Löschen zum Entfernen von Entitäten aus Ihrem Inventar. Beide Vorgänge werden für eine Reihe von Entitäten ausgeführt, die im Anfragetext aufgeführt sind. Sie können in einem einzigen API-Aufruf Aktualisierungen für bis zu 1.000 Entitäten vornehmen. Die API akzeptiert alle eingehenden Anfragen und stellt sie zur weiteren Verarbeitung in eine Warteschlange.
Daher werden RTU-Anfragen asynchron verarbeitet.
Die API für Echtzeitaktualisierungen wird in zwei Umgebungen ausgeführt: in der Sandbox und in der Produktion.
Die Sandbox-Umgebung wird zum Testen der API-Anfragen und der Produktionsumgebung verwendet, um die für Bestell-End-to-End-Nutzer sichtbaren Inhalte zu aktualisieren. Hostnamen beider Umgebungen:
Sandbox – partnerdev-mapsbooking.googleapis.com
Produktion – mapsbooking.googleapis.com
Endpunkte
Die API für Echtzeitaktualisierungen stellt zwei Endpunkte zur Verarbeitung der eingehenden Anfragen nach Inventaraktualisierungen bereit:
Der Parameter PARTNER_ID wird im Actions Center als Partner-ID auf der Seite Konto und Nutzer angezeigt, wie im Screenshot unten dargestellt.
Wenn wir aus dem obigen Screenshot 10000001 als Wert für PARTNER_ID nehmen, sehen die vollständigen URLs zum Senden von API-Anfragen in der Sandbox und in der Produktion in den folgenden Beispielen aus.
# Production UPSERT
https://mapsbooking.googleapis.com/v1alpha/inventory/partners/10000001/feeds/owg.v2/record:batchPush
# Production DELETE
https://mapsbooking.googleapis.com/v1alpha/inventory/partners/10000001/feeds/owg.v2/record:batchDelete
Entitäten aktualisieren
Verwenden Sie den UPSERT-Endpunkt und senden Sie HTTP-POST-Anfragen, um Entitäten in Ihrem Inventar zu aktualisieren. Jede POST-Anfrage muss den Parameter PARTNER_ID zusammen mit der JSON-Nutzlast enthalten, die die strukturierten Daten eines beliebigen Entitätstyps im Inventarschema enthält.
Nutzlast der Upsert-Anfrage
Der Anfragetext ist ein JSON-Objekt mit einer Liste von Datensätzen. Jeder Datensatz entspricht einer Entität, die aktualisiert wird. Es besteht aus dem Feld data_record mit der in Base64 codierten Entitätsnutzlast und dem generation_timestamp, der den Zeitpunkt der Entitätsaktualisierung angibt:
BASE_64_ENCODED_ENTITY: Base64-codierter JSON-String der Entität. Die JSON-Datei der decodierten Entität sollte dieselbe Struktur wie in der Feedspezifikation haben, zum Beispiel:
{"@type":"MenuSection","name":"My Updated Menu Section","menuId":{"@id":"10824","displayOrder":1},"@id":"853705"}
UPDATE_TIMESTAMP: Geben Sie unbedingt den Zeitstempel an, zu dem die Entität in Ihren Back-End-Systemen generiert wurde. Mit diesem Zeitstempel wird die korrekte Reihenfolge von Inventaraktualisierungen sichergestellt. Wenn dieses Feld nicht enthalten ist, wird es auf den Zeitpunkt festgelegt, zu dem Google die Anfrage erhält. Beim Aktualisieren einer Entität über eine batchPush-Anfrage wird das Feld generation_timestamp für die Entitätsversionsverwaltung verwendet. Sehen Sie sich das erwartete Format der Zeitwerte im relationalen Inventarschema an.
Jede Anfrage für eine Echtzeitaktualisierung muss die folgenden Bedingungen erfüllen:
Der Nutzlasttext darf nicht größer als 5 MB sein. Ähnlich wie bei Batchfeeds empfehlen wir Ihnen, Leerzeichen zu entfernen, um mehr Daten anzupassen.
Eine batchPush-Anfrage kann bis zu 1.000 Entitäten enthalten.
Beispiele
Beispiel 1: Ein Restaurant aktualisieren
Angenommen, Sie müssen die Telefonnummer eines Restaurants dringend aktualisieren. Dein Update enthält den JSON-Code für das gesamte Restaurant.
Verwenden Sie keine Echtzeitaktualisierungen, um neue Entitäten hinzuzufügen, da dies zu Dateninkonsistenzen führen kann. Verwenden Sie stattdessen die Batch-Feeds wie unter Batch-Aufnahme beschrieben.
Entitäten löschen
Verwenden Sie den EndpunktDELETE und senden Sie HTTP-POST-Anfragen, um Entitäten aus Ihrem Inventar zu löschen. Jede POST-Anfrage muss den Parameter PARTNER_ID zusammen mit der JSON-Nutzlast enthalten, die die ID einer Entität in Ihrem Inventar enthält.
Anfragenutzlast löschen
Der Text einer Löschanfrage ist ähnlich wie eine Aktualisierungsanfrage strukturiert.
Es enthält auch eine Liste von Datensätzen mit den Feldern data_record und delete_time:
BASE_64_ENCODED_REFERENCE: Base64-codierter JSON-String des Verweises auf die Entität, die entfernt wird. Ein Verweis besteht nur aus dem Entitätstyp und der Kennung, z. B. eine JSON-Darstellung eines Verweises auf einen MenuSection-Wert:
{"@type":"MenuSection","@id":"853705"}
DELETE_TIMESTAMP: Geben Sie unbedingt den Zeitstempel für den Zeitpunkt an, zu dem die Entität in Ihrem Back-End-System gelöscht wurde. Anhand dieses Zeitstempels wird die Reihenfolge bestimmt, in der ein Löschvorgang auf das Inventar angewendet wird.
Eine batchDelete-Anfrage kann bis zu 1.000 Entitäten enthalten.
Beispiele
Beispiel 1: Zwei MenuItem-Elemente entfernen
Um zwei Menüelemente in einem einzelnen API-Aufruf zu entfernen, würde die HTTP-POST-Anfrage so aussehen:
Angenommen, Sie möchten ein Restaurant im Batch-Feed löschen.
Sie dürfen nur die Restaurantentität löschen. Löschen Sie keine untergeordneten Elemente wie Dienste und Menüs, da sie automatisch entfernt werden.
Beispielanfrage zum Löschen einer Restaurantentität mit der ID https://www.provider.com/restaurant/12345:
Bei den API-Aufrufen für die Echtzeitaktualisierung werden zwei Arten von Validierungen durchgeführt:
Anfrageebene: Diese Validierungen prüfen, ob die Nutzlast dem Schema upsert oder delete folgt und jeder data_record sowohl die Felder @id als auch @type enthält.
Diese Prüfungen sind synchron und die Ergebnisse werden im API-Antworttext zurückgegeben. Der Antwortcode 200 und der leere JSON-Text {} bedeutet, dass diese Validierungen bestanden wurden und die Entitäten in dieser Anfrage zur Verarbeitung in die Warteschlange gestellt wurden. Ein anderer Antwortcode als 200 bedeutet, dass eine oder mehrere dieser Validierungen fehlgeschlagen sind und die gesamte Anfrage abgelehnt wurde (einschließlich aller Entitäten in der Nutzlast). Wenn in einem data_record beispielsweise ein @type fehlt, wird die folgende Fehlerantwort zurückgegeben:
{
"error": {
"code": 400,
"message": "Record:{\"@id\":\"2717/86853/DELIVERY\",\"applicableServiceType\":[\"DELIVERY\",\"TAKEOUT\"],\"menuId\":[{\"@id\":\"2717/DELIVERY\",\"displayOrder\":1},{\"@id\":\"2717/TAKEOUT\",\"displayOrder\":2}],\"name\":\"Salad\",\"offeredById\":[\"2717\"]} has following errors: \nThe entity type could not be extracted from the entity value.\n",
"status": "INVALID_ARGUMENT",
"details": [
{
"@type": "type.googleapis.com/google.rpc.DebugInfo",
"detail": "[ORIGINAL ERROR] generic::invalid_argument: Failed to parse one or more rtu records. Record:{\"@id\":\"2717/86853/DELIVERY\",\"applicableServiceType\":[\"DELIVERY\",\"TAKEOUT\"],\"menuId\":[{\"@id\":\"2717/DELIVERY\",\"displayOrder\":1},{\"@id\":\"2717/TAKEOUT\",\"displayOrder\":2}],\"name\":\"Salad\",\"offeredById\":[\"2717\"]} has following errors: \nThe entity type could not be extracted from the entity value.\n [google.rpc.error_details_ext] { message: \"Record:{\\\"@id\\\":\\\"2717/86853/DELIVERY\\\",\\\"applicableServiceType\\\":[\\\"DELIVERY\\\",\\\"TAKEOUT\\\"],\\\"menuId\\\":[{\\\"@id\\\":\\\"2717/DELIVERY\\\",\\\"displayOrder\\\":1},{\\\"@id\\\":\\\"2717/TAKEOUT\\\",\\\"displayOrder\\\":2}],\\\"name\\\":\\\"Salad\\\",\\\"offeredById\\\":[\\\"2717\\\"]} has following errors: \\nThe entity type could not be extracted from the entity value.\\n\" }"
}
]
}
}
Entitätsebene: Jede Entität in der Nutzlast wird anhand des relationalen Schemas validiert.
In dieser Phase der Überprüfung auftretende Probleme werden nicht in der API-Antwort gemeldet. Sie werden nur im RTU Reporting-Dashboard gemeldet.
API-Kontingente
API-Updates in Echtzeit haben ein Kontingent von 1.500 Anfragen alle 60 Sekunden oder 25 Anfragen pro Sekunde im Durchschnitt. Wenn ein Kontingent überschritten wird, antwortet Google mit der folgenden Fehlermeldung:
Wiederhole den Aufruf in diesem Fall in exponentiell größeren Abständen, bis er erfolgreich ist. Wenn Sie das Kontingent regelmäßig ausschöpfen, können Sie mehr Entitäten in eine API-Anfrage aufnehmen. Ein API-Aufruf kann bis zu 1.000 Entitäten umfassen.
Codebeispiele
Im Folgenden finden Sie einige Beispiele für die Verwendung der Realtime Update API in verschiedenen Sprachen. In diesen Beispielen werden die Google-Authentifizierungsbibliotheken zur Authentifizierung mithilfe einer Dienstkonto-Schlüsseldatei verwendet, die während der Kontoeinrichtung generiert wurde.
Alternative Lösungen finden Sie unter OAuth 2.0 für Server-zu-Server-Anwendungen verwenden.
Sie können das unter Clientbibliotheken generieren verfügbare Schema verwenden, um Quellcode für die Objekttypen „Inventar“ und „Echtzeitaktualisierung“ zu generieren.
/* Sample code for Real-time update batchPush implementation.
*
* Required libraries:
* - google-auth-library
*/
const {JWT} = require('google-auth-library');
// ACTION REQUIRED: Change this to the path of the service account client secret
// file downloaded from the Google Cloud Console.
const serviceAccountJson = require('./service-account.json');
// ACTION REQUIRED: Change this to your Partner ID received from Google.
// The Partner ID is available on the Partner Portal.
const PARTNER_ID = 1234;
const HOST = {
prod: 'https://mapsbooking.googleapis.com',
sandbox: 'https://partnerdev-mapsbooking.googleapis.com'
};
// ACTION REQUIRED: Change to 'prod' for production
const ENV = 'sandbox';
// Feed name for Order with Google including the version.
const FEED_NAME = 'owg.v2';
// Endpoint url
const url = `${HOST[ENV]}/v1alpha/inventory/partners/${PARTNER_ID}/feeds/${
FEED_NAME}/record:batchPush`;
/**
* Send a Real-time update request to update/insert entities
*/
async function batchUpsert(entities) {
/**
* Sign JWT token using private key from service account secret file
* provided. The client can be created without providing a service account
* secret file by implementing Application Default Credentials.
* https://github.com/googleapis/google-auth-library-nodejs
*/
const client = new JWT({
email: serviceAccountJson.client_email,
key: serviceAccountJson.private_key,
scopes: ['https://www.googleapis.com/auth/mapsbooking'],
});
const request = {records: toPushRecords(entities)};
const body = JSON.stringify(request);
try {
const response = await client.request({
method: 'POST',
url,
data: body,
headers: {'Content-Type': 'application/json'}
});
console.log('request body:', body);
console.log('response status:', response.status);
console.log(
'response data:', response.data); // successful response returns '{}'
} catch (error) {
console.log('error:', error);
}
}
/**
* Maps array of entities to records for batch push requests
*/
const toPushRecords = (entities) => {
return entities.map((entity) => {
// Using dateModified to set generation_timestamp. Defaulting to the
// current timestamp for records that do not have dateModified.
const generation_timestamp =
entity.dateModified ? entity.dateModified : new Date().toISOString();
return {data_record: btoa(JSON.stringify(entity)), generation_timestamp};
});
};
// Call batchUpsert with example entities. dateModified is optional and is
// used to hold the actual timestamp when the entity was updated/created.
batchUpsert([
{
'@type': 'MenuItemOffer',
'@id': '6680261',
'menuItemId': '18931508',
'price': 15.5,
'priceCurrency': 'USD',
'applicableServiceType': ['DELIVERY', 'TAKEOUT'],
'inventoryLevel': 0,
'dateModified': '2022-06-19T15:43:50.970Z'
},
{
'@type': 'MenuItemOffer',
'@id': '6680262',
'menuItemId': '18931509',
'price': 25.5,
'priceCurrency': 'USD',
'applicableServiceType': ['DELIVERY', 'TAKEOUT'],
'inventoryLevel': 0,
'dateModified': '2022-06-19T15:43:50.970Z'
}
]);
"""Sample code for the Real-time update batchPush implementation."""
# Required libraries:
# - google-auth
import base64
import datetime
import json
from google.auth.transport.requests import AuthorizedSession
from google.oauth2 import service_account
# ACTION REQUIRED: Change this to the Partner ID received from Google.
# Partner ID is available on the Partner Portal.
# https://partnerdash.google.com/apps/reservewithgoogle
_PARTNER_ID = '1234'
# ACTION REQUIRED: Change this to the path of the service account client secret
# file downloaded from the Google Cloud Console.
_SERVICE_ACCOUNT_KEY_JSON_FILE = 'service-account-creds.json'
_HOST_MAP = {
'sandbox': 'https://partnerdev-mapsbooking.googleapis.com',
'prod': 'https://mapsbooking.googleapis.com'
}
# ACTION REQUIRED: Change to 'prod' for production
_ENV = 'sandbox'
# Feed name for Order with Google including the version.
_FEED_NAME = 'owg.v2'
_ENDPOINT = '{}/v1alpha/inventory/partners/{}/feeds/{}/record:batchPush'.format(
_HOST_MAP[_ENV], _PARTNER_ID, _FEED_NAME)
def batch_upsert(entities):
"""Makes a batchPush request using the Real-time updates REST service.
Args:
entities: The list of entity objects to update or add.
"""
# Creates credentials by providing a json file. Credentials can also be
# provided by implementing Application Default Credentials.
# https://googleapis.dev/python/google-auth/latest/user-guide.html
credentials = service_account.Credentials.from_service_account_file(
_SERVICE_ACCOUNT_KEY_JSON_FILE,
scopes=['https://www.googleapis.com/auth/mapsbooking'])
authorized_session = AuthorizedSession(credentials)
# JSON request object
batch_request = {'records': [create_push_record(x) for x in entities]}
response = authorized_session.post(_ENDPOINT, json=batch_request)
print('request body:', json.dumps(batch_request))
print('response status:', response.status_code)
print('response data:', response.text) # successful response returns '{}'
def create_push_record(entity):
"""Creates a record from an entity for batchPush requests.
Args:
entity: The entity object to create the record from.
Returns:
The constructed record for the batchPush request payload.
"""
data_bytes = json.dumps(entity).encode('utf-8')
base64_bytes = base64.b64encode(data_bytes)
# Using dateModified to set generation_timestamp. Defaulting to the
# current timestamp for records that do not have dateModified.
generation_timestamp = entity.dateModified if 'dateModified' in entity else datetime.datetime.now(
).strftime('%Y-%m-%dT%H:%M:%S.%fZ')
return {
'generation_timestamp': generation_timestamp,
'data_record': base64_bytes.decode('utf-8')
}
# Call batch_upsert with example entities. dateModified is optional and is
# used to hold the actual timestamp when the entity was updated/created.
batch_upsert([{
'@type': 'MenuItemOffer',
'@id': '6680261',
'menuItemId': '18931508',
'price': 15.5,
'priceCurrency': 'USD',
'applicableServiceType': ['DELIVERY', 'TAKEOUT'],
'inventoryLevel': 0,
'dateModified': '2022-06-19T15:43:50.970Z'
}, {
'@type': 'MenuItemOffer',
'@id': '6680262',
'menuItemId': '18931509',
'price': 25.5,
'priceCurrency': 'USD',
'applicableServiceType': ['DELIVERY', 'TAKEOUT'],
'inventoryLevel': 0,
'dateModified': '2022-06-19T15:43:50.970Z'
}])
Die Client-Quellcodemodelle in den Paketen rtusamples.inventory und rtusamples.realtime wurden anhand der Schritte unter Clientbibliotheken generieren erstellt.
/*
* Required Libraries:
* - JDK >= 11
* - google-auth-library-oauth2-http
*/
package rtusamples;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.auth.oauth2.AccessToken;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.FileInputStream;
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpRequest.BodyPublishers;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.nio.charset.Charset;
import java.time.Clock;
import java.time.OffsetDateTime;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Base64;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
import rtusamples.inventory.MenuItemOffer;
import rtusamples.inventory.MenuItemOfferType;
import rtusamples.inventory.ServiceTypeElement;
import rtusamples.realtime.BatchPushGenericRecordRequest;
import rtusamples.realtime.GenericRecord;
/** Sample code for Real-time update batchPush implementation. */
public final class BasicPush {
// ACTION REQUIRED: Change this to your Partner ID received from Google. The Partner ID is
// available on the Partner Portal.
private static final long PARTNER_ID = 12345678;
// ACTION REQUIRED: Change this to the path of the service account client secret file downloaded
// from the Google Cloud Console.
private static final String JSON_KEY_FULL_PATH =
"<path to your JSON credentials>/credentials.json";
// ACTION REQUIRED: Change this to the endpoint that is needed.
private static final String ENDPOINT =
// "https://partnerdev-mapsbooking.googleapis.com"; // for sandbox
"https://mapsbooking.googleapis.com"; // for prod
// Feed name for Order with Google including the version.
private static final String FEED_NAME = "owg.v2";
private static final ObjectMapper objectMapper = new ObjectMapper();
private static final DateTimeFormatter TIMESTAMP_FORMATTER =
DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss[.SSS]'Z'");
private static final Charset UTF_8 = Charset.forName("UTF-8");
public static void main(String[] args) throws Exception {
/**
* Create credentials from service account secret file. Alternatively, the credentials can be
* created by implementing Application Default Credentials.
* https://github.com/googleapis/google-auth-library-java
*/
// GoogleCredentials sourceCredentials =
// GoogleCredentials.getApplicationDefault()
// .createScoped(Arrays.asList("https://www.googleapis.com/auth/mapsbooking"));
// ImpersonatedCredentials credentials =
// ImpersonatedCredentials.create(
// sourceCredentials,
// "fo-test@projectname.iam.gserviceaccount.com",
// null,
// Arrays.asList("https://www.googleapis.com/auth/mapsbooking"),
// 300);
GoogleCredentials credentials =
GoogleCredentials.fromStream(new FileInputStream(JSON_KEY_FULL_PATH))
.createScoped(Arrays.asList("https://www.googleapis.com/auth/mapsbooking"));
// Create example MenuItemOffer entities, dateModified is optional and is used to hold
// the actual timestamp when the entity was updated/created.
MenuItemOffer menuItemOfferPizza = new MenuItemOffer();
menuItemOfferPizza.setID("6680261");
menuItemOfferPizza.setType(MenuItemOfferType.MENU_ITEM_OFFER);
menuItemOfferPizza.setMenuItemID("18931508");
menuItemOfferPizza.setPrice(15.5);
menuItemOfferPizza.setPriceCurrency("USD");
menuItemOfferPizza.setApplicableServiceType(
new ServiceTypeElement[] {ServiceTypeElement.TAKEOUT, ServiceTypeElement.DELIVERY});
menuItemOfferPizza.setInventoryLevel(0.0);
menuItemOfferPizza.setDateModified("2022-10-07T13:00:00.000Z");
MenuItemOffer menuItemOfferSalad = new MenuItemOffer();
menuItemOfferSalad.setID("6680262");
menuItemOfferSalad.setType(MenuItemOfferType.MENU_ITEM_OFFER);
menuItemOfferSalad.setMenuItemID("18931509");
menuItemOfferSalad.setPrice(25.5);
menuItemOfferSalad.setPriceCurrency("USD");
menuItemOfferSalad.setApplicableServiceType(
new ServiceTypeElement[] {ServiceTypeElement.TAKEOUT, ServiceTypeElement.DELIVERY});
menuItemOfferSalad.setInventoryLevel(0.0);
menuItemOfferSalad.setDateModified("2022-10-07T13:00:00.000Z");
// Example array of MenuItemOffer entities to update.
List<MenuItemOffer> menuItemOffers = Arrays.asList(menuItemOfferPizza, menuItemOfferSalad);
// Create list of GenericRecord from menuItemOffers.
List<GenericRecord> menuItemOfferGenericRecords =
menuItemOffers.stream()
.map(
(menuItemOffer) ->
toBatchPushRecord(menuItemOffer, menuItemOffer.getDateModified()))
.collect(Collectors.toList());
// List of records to be updated/created.
List<GenericRecord> recordsToBeUpdated = new ArrayList<>();
// Add list of menuItemOffer generic records.
recordsToBeUpdated.addAll(menuItemOfferGenericRecords);
// Request object that contains all records.
BatchPushGenericRecordRequest batchPushRequest = new BatchPushGenericRecordRequest();
batchPushRequest.setRecords(recordsToBeUpdated.toArray(new GenericRecord[0]));
// Execute batchPush request.
BasicPush basicPush = new BasicPush();
basicPush.batchPush(batchPushRequest, credentials);
}
public void batchPush(
BatchPushGenericRecordRequest batchPushRequest, GoogleCredentials credentials)
throws IOException {
credentials.refreshIfExpired();
AccessToken token = credentials.getAccessToken();
String requestBody = objectMapper.writeValueAsString(batchPushRequest);
HttpClient client = HttpClient.newHttpClient();
HttpRequest request =
HttpRequest.newBuilder()
.uri(
URI.create(
String.format(
"%s/v1alpha/inventory/partners/%s/feeds/%s/record:batchPush",
ENDPOINT, PARTNER_ID, FEED_NAME)))
.header("Content-Type", "application/json")
.header("Authorization", String.format("Bearer %s", token.getTokenValue()))
.POST(BodyPublishers.ofString(requestBody))
.build();
HttpResponse<String> response = null;
try {
response = client.send(request, BodyHandlers.ofString());
System.out.println("Request body:" + requestBody);
System.out.println("Response status:" + response.statusCode());
System.out.println("Response body:" + response.body());
} catch (IOException | InterruptedException e) {
e.printStackTrace();
}
}
public static <T> GenericRecord toBatchPushRecord(T entity, String dateModified) {
GenericRecord genericRecord = new GenericRecord();
try {
String json = objectMapper.writeValueAsString(entity);
genericRecord.setDataRecord(Base64.getEncoder().encodeToString(json.getBytes(UTF_8)));
// Using dateModified to set generation_timestamp. Defaulting to the
// current timestamp for records that do not have dateModified.
String generationTimestamp =
Optional.ofNullable(dateModified)
.orElse(OffsetDateTime.now(Clock.systemUTC()).format(TIMESTAMP_FORMATTER));
genericRecord.setGenerationTimestamp(generationTimestamp);
} catch (JsonProcessingException e) {
System.out.println(e.getMessage());
}
return genericRecord;
}
}
/* Sample code for Real-time update batchDelete implementation.
*
* Required libraries:
* - google-auth-library
*/
const {JWT} = require('google-auth-library');
// ACTION REQUIRED: Change this to the path of the service account client secret
// file downloaded from the Google Cloud Console.
const serviceAccountJson = require('./service-account.json');
// ACTION REQUIRED: Change this to your Partner ID received from Google.
// The Partner ID is available on the Partner Portal.
const PARTNER_ID = 1234;
const HOST = {
prod: 'https://mapsbooking.googleapis.com',
sandbox: 'https://partnerdev-mapsbooking.googleapis.com'
};
// ACTION REQUIRED: Change to 'prod' for production
const ENV = 'sandbox';
// Feed name for Order with Google including the version.
const FEED_NAME = 'owg.v2';
// Endpoint url
const url = `${HOST[ENV]}/v1alpha/inventory/partners/${PARTNER_ID}/feeds/${
FEED_NAME}/record:batchDelete`;
/**
* Send a Real-time update request to delete entities
*/
async function batchDelete(entities) {
try {
/**
* Sign JWT token using private key from service account secret file
* provided. The client can be created without providing a service account
* secret file by implementing Application Default Credentials.
* https://github.com/googleapis/google-auth-library-nodejs
*/
const client = new JWT({
email: serviceAccountJson.client_email,
key: serviceAccountJson.private_key,
scopes: ['https://www.googleapis.com/auth/mapsbooking'],
});
const request = {
records: toDeleteRecords(entities)
};
const body = JSON.stringify(request);
try {
const response = await client.request({
method: 'POST',
url,
data: body,
headers: {'Content-Type': 'application/json'}
});
console.log('request body:', body);
console.log('response status:', response.status);
console.log('response data:', response.data); // successful response returns '{}'
} catch (error) {
console.log('error:', error);
}
}
/**
* Maps array of entities to records for batch delete requests
*/
const toDeleteRecords = (entities) => {
return entities.map((entity) => {
// Using dateModified to set delete_time. Defaulting to the current
// timestamp for records that do not have dateModified.
const delete_time =
entity.dateModified ? entity.dateModified : new Date().toISOString();
return {data_record: btoa(JSON.stringify(entity)), delete_time};
});
};
// Call batchDelete with example entities. dateModified is optional and is
// used to hold the actual timestamp when the entity was deleted.
batchDelete([
{
'@type': 'Menu',
'@id': '853706',
'dateModified': '2022-06-19T15:43:50.970Z'
},
{
'@type': 'Menu',
'@id': '853705',
'dateModified': '2022-06-19T15:13:00.280Z'
}
]);
"""Sample code for the Real-time update batchDelete implementation."""
# Required libraries:
# - google-auth
import base64
import datetime
import json
from google.auth.transport.requests import AuthorizedSession
from google.oauth2 import service_account
# ACTION REQUIRED: Change this to the Partner ID received from Google.
# Partner ID is available on the Partner Portal.
# https://partnerdash.google.com/apps/reservewithgoogle
_PARTNER_ID = '1234'
# ACTION REQUIRED: Change this to the path of the service account client secret
# file downloaded from the Google Cloud Console.
_SERVICE_ACCOUNT_KEY_JSON_FILE = 'service-account-creds.json'
_HOST_MAP = {
'sandbox': 'https://partnerdev-mapsbooking.googleapis.com',
'prod': 'https://mapsbooking.googleapis.com'
}
# ACTION REQUIRED: Change to 'prod' for production
_ENV = 'sandbox'
# Feed name for Order with Google including the version.
_FEED_NAME = 'owg.v2'
_ENDPOINT = '{}/v1alpha/inventory/partners/{}/feeds/{}/record:batchDelete'.format(
_HOST_MAP[_ENV], _PARTNER_ID, _FEED_NAME)
def batch_delete(entities):
"""Makes a batch delete request using the Real-time updates REST service.
Args:
entities: The list of entity objects to delete.
"""
# Creates credentials by providing a json file. Credentials can also be
# provided by implementing Application Default Credentials.
# https://googleapis.dev/python/google-auth/latest/user-guide.html
credentials = service_account.Credentials.from_service_account_file(
_SERVICE_ACCOUNT_KEY_JSON_FILE,
scopes=['https://www.googleapis.com/auth/mapsbooking'])
authorized_session = AuthorizedSession(credentials)
# JSON request object
batch_request = {'records': [create_delete_record(x) for x in entities]}
response = authorized_session.post(_ENDPOINT, json=batch_request)
print('request body:', json.dumps(batch_request))
print('response status:', response.status_code)
print('response data:', response.text) # successful response returns '{}'
def create_delete_record(entity):
"""Creates a record from an entity for batchDelete requests.
Args:
entity: The entity object to create the record from.
Returns:
The constructed record for the batchDelete request payload.
"""
data_bytes = json.dumps(entity).encode('utf-8')
base64_bytes = base64.b64encode(data_bytes)
# Using dateModified to set delete_time. Defaulting to the current
# timestamp for records that do not have dateModified.
delete_time = entity.dateModified if 'dateModified' in entity else datetime.datetime.now(
).strftime('%Y-%m-%dT%H:%M:%S.%fZ')
return {
'delete_time': delete_time,
'data_record': base64_bytes.decode('utf-8')
}
# Call batch_delete with example entities. dateModified is optional and is
# used to hold the actual timestamp when the entity was deleted.
batch_delete([{
'@type': 'Menu',
'@id': '853706',
'dateModified': '2022-06-19T13:10:00.000Z'
}, {
'@type': 'Menu',
'@id': '853705',
'dateModified': '2022-06-19T13:30:10.000Z'
}])
Die Client-Quellcodemodelle in den Paketen rtusamples.inventory und rtusamples.realtime wurden anhand der Schritte unter Clientbibliotheken generieren erstellt.
/*
* Required Libraries:
* - JDK >= 11
* - google-auth-library-oauth2-http
*/
package rtusamples;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.auth.oauth2.AccessToken;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.FileInputStream;
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpRequest.BodyPublishers;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.nio.charset.Charset;
import java.time.Clock;
import java.time.OffsetDateTime;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Base64;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
import rtusamples.inventory.Menu;
import rtusamples.inventory.MenuType;
import rtusamples.realtime.BatchDeleteGenericRecordsRequest;
import rtusamples.realtime.GenericDeleteRecord;
/** Sample code for the Real-time update batchDelete implementation. */
public final class BasicDelete {
// ACTION REQUIRED: Change this to your Partner ID received from Google. The Partner ID is
// available on the Partner Portal.
private static final long PARTNER_ID = 123456789;
// ACTION REQUIRED: Change this to the path of the service account client secret file downloaded
// from the Google Cloud Console.
private static final String JSON_KEY_FULL_PATH =
"<path to your JSON credentials>/credentials.json";
// ACTION REQUIRED: Change this to the endpoint that is needed.
private static final String ENDPOINT =
"https://partnerdev-mapsbooking.googleapis.com"; // for sandbox
// "https://mapsbooking.googleapis.com" // for prod
// Feed name for Order with Google including the version.
private static final String FEED_NAME = "owg.v2";
private static final ObjectMapper objectMapper = new ObjectMapper();
private static final DateTimeFormatter TIMESTAMP_FORMATTER =
DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss[.SSS]'Z'");
private static final Charset UTF_8 = Charset.forName("UTF-8");
public static void main(String[] args) throws Exception {
/**
* Create credentials from service account secret file. Alternatively, the credentials can be
* created by implementing Application Default Credentials.
* https://github.com/googleapis/google-auth-library-java
*/
// GoogleCredentials sourceCredentials =
// GoogleCredentials.getApplicationDefault()
// .createScoped(Arrays.asList("https://www.googleapis.com/auth/mapsbooking"));
// ImpersonatedCredentials credentials =
// ImpersonatedCredentials.create(
// sourceCredentials,
// "fo-test@projectname.iam.gserviceaccount.com",
// null,
// Arrays.asList("https://www.googleapis.com/auth/mapsbooking"),
// 300);
GoogleCredentials credentials =
GoogleCredentials.fromStream(new FileInputStream(JSON_KEY_FULL_PATH))
.createScoped(Arrays.asList("https://www.googleapis.com/auth/mapsbooking"));
// Create example Menu entities, dateModified is optional and is used to hold
// the actual timestamp when the entity was deleted.
Menu menuLunch = new Menu();
menuLunch.setID("853705");
menuLunch.setType(MenuType.MENU);
menuLunch.setDateModified("2022-09-19T13:10:00.000Z");
Menu menuDinner = new Menu();
menuDinner.setID("853706");
menuDinner.setType(MenuType.MENU);
menuDinner.setDateModified("2022-09-19T13:13:10.000Z");
// Example array of Menu entities to update.
List<Menu> menus = Arrays.asList(menuLunch, menuDinner);
// Create list of GenericDeleteRecord from menus.
List<GenericDeleteRecord> menuGenericDeleteRecords =
menus.stream()
.map((menu) -> toBatchDeleteRecord(menu, menu.getDateModified()))
.collect(Collectors.toList());
// List of records to be deleted.
List<GenericDeleteRecord> recordsToBeDeleted = new ArrayList<>();
// Add list of menu generic records.
recordsToBeDeleted.addAll(menuGenericDeleteRecords);
// Request object that contains all records.
BatchDeleteGenericRecordsRequest batchDeleteRequest = new BatchDeleteGenericRecordsRequest();
batchDeleteRequest.setRecords(recordsToBeDeleted.toArray(new GenericDeleteRecord[0]));
// Execute batchDelete request.
BasicDelete basicDelete = new BasicDelete();
basicDelete.batchDelete(batchDeleteRequest, credentials);
}
public void batchDelete(
BatchDeleteGenericRecordsRequest batchDeleteRequest, GoogleCredentials credentials)
throws IOException {
credentials.refreshIfExpired();
AccessToken token = credentials.getAccessToken();
String requestBody = objectMapper.writeValueAsString(batchDeleteRequest);
HttpClient client = HttpClient.newHttpClient();
HttpRequest request =
HttpRequest.newBuilder()
.uri(
URI.create(
String.format(
"%s/v1alpha/inventory/partners/%s/feeds/%s/record:batchDelete",
ENDPOINT, PARTNER_ID, FEED_NAME)))
.header("Content-Type", "application/json")
.header("Authorization", String.format("Bearer %s", token.getTokenValue()))
.POST(BodyPublishers.ofString(requestBody))
.build();
HttpResponse<String> response = null;
try {
response = client.send(request, BodyHandlers.ofString());
System.out.println("Request body:" + requestBody);
System.out.println("Response status:" + response.statusCode());
System.out.println("Response body:" + response.body());
} catch (IOException | InterruptedException e) {
e.printStackTrace();
}
}
public static <T> GenericDeleteRecord toBatchDeleteRecord(T entity, String dateModified) {
GenericDeleteRecord genericRecord = new GenericDeleteRecord();
try {
String json = objectMapper.writeValueAsString(entity);
genericRecord.setDataRecord(Base64.getEncoder().encodeToString(json.getBytes(UTF_8)));
// Using dateModified to set delete_time. Defaulting to the current
// timestamp for records that do not have dateModified.
String deleteTime =
Optional.ofNullable(dateModified)
.orElse(OffsetDateTime.now(Clock.systemUTC()).format(TIMESTAMP_FORMATTER));
genericRecord.setDeleteTime(deleteTime);
} catch (JsonProcessingException e) {
System.out.println(e.getMessage());
}
return genericRecord;
}
}
Anwendungsfälle
Die folgenden Anwendungsfälle sind Beispiele für Echtzeitaktualisierungen, Batch-Feed-Aktualisierungen und den Inhalt auf übergeordneter Ebene des API-Aufrufs:
Szenario
Zu aktualisierende Entität
Beschreibung und Effekte
Dienst deaktivieren
Service
Sie müssen einen Dienst aus unvorhergesehenen Gründen deaktivieren.
Echtzeitaktualisierungen: Aktualisieren Sie die betreffende Entität Service. Dazu setzen Sie das Attribut isDisabled auf true. Andere Attribute bleiben unverändert.
Vollständige Feeds:Aktualisieren Sie die Entität aus den vollständigen Feeds so, dass isDisabled vor dem nächsten Abruf durch Google auf true gesetzt ist. Andernfalls wird die Entität wieder aktiviert.
Ein bestimmter Artikel ist nicht auf Lager
MenuItemOffer
Echtzeitaktualisierungen: Sendet die kapselnde MenuItemOffer-Entität, wobei inventoryLevel für die angegebene MenuItem auf 0 gesetzt ist und alle anderen Daten unverändert bleiben.
Preisänderung auf Speisekarte
MenuItemOffer
Echtzeitaktualisierungen: Sendet die kapselnde MenuItemOffer-Entität, wobei price auf den aktualisierten Preis für die angegebene MenuItem festgelegt ist und alle anderen Daten unverändert bleiben.
Neues Element der obersten Ebene hinzufügen
Gilt nur für Entitäten der Typen Menu, Restaurant und Service.
Menu, Restaurant, Service
Beispielsweise müssen Sie einem Restaurant eine neue Speisekarte hinzufügen.
Vollständige Feeds:Fügen Sie die Entität Ihren Datenfeeds hinzu und warten Sie auf die Batchaufnahme.
Element der obersten Ebene endgültig löschen
Gilt nur für Entitäten der Typen Menu, Restaurant und Service.
Vollständige Feeds:Die Entität muss vor dem nächsten Abruf durch Google aus den vollständigen Feeds entfernt werden. Andernfalls wird die Entität wieder hinzugefügt.
Neues Liefergebiet in einem bestimmten Service hinzufügen
ServiceArea
Batchfeeds:Senden Sie die betreffende Entität ServiceArea mit allen Feldern intakt, wie Sie es auch normalerweise in den vollständigen Feeds tun würden, und geben Sie dabei einen neuen Lieferbereich in polygon, geoRadius oder postalCode an.
Voraussichtliche Lieferzeit in Service aktualisieren
ServiceHours
Batchfeeds:Senden Sie ServiceHours wie in den Feeds, außer dass leadTimeMin entsprechend aktualisiert wird.
Lieferpreise in Service aktualisieren
Fee
Batchfeeds: Vollständige Übermittlung Fee senden, wobei price aktualisiert wird.
Liefer- oder Abholzeiten in Service aktualisieren
ServiceHours
Batchfeeds:Senden Sie ServiceHours genau wie in den Feeds, außer dass die Eigenschaften opens und closes entsprechend aktualisiert werden.
Service (Mindestbestellbetrag ändern)
Fee
Batchfeeds:Vollständige Fee senden, wobei minPrice aktualisiert wird
MenuItem endgültig löschen
Menu
Batchfeeds:Senden Sie MenuItem wie in den Feeds, aber mit leerem parentMenuSectionId.
Verarbeitungszeiten für Batchjobs und Echtzeitaktualisierungen
Eine Entität, die über einen Batchfeed aktualisiert oder gelöscht wird, wird innerhalb von zwei Stunden verarbeitet. Eine Entität, die durch eine Echtzeitaktualisierung aktualisiert wird, wird innerhalb von 5 Minuten verarbeitet. Eine veraltete Entität wird nach 14 Tagen gelöscht.
Sie können Google folgende Informationen senden:
Mehrere Batch-Aufträge pro Tag, um Ihr Inventar auf dem neuesten Stand zu halten ODER
Ein Batchjob pro Tag und Aktualisierungen in Echtzeit, um Ihr Inventar auf dem neuesten Stand zu halten.
