API 認証では、任意の言語で Google クライアント ライブラリをインストールすることをおすすめします。OAuth スコープとして「https://www.googleapis.com/auth/mapsbooking」を使用します。以下のコードサンプルでは、これらのライブラリを使用しています。それ以外の場合は、OAuth 2.0 を使用した Google API へのアクセスで説明されているように、トークン交換を手動で処理する必要があります。
概要
Real-time updates API は、2 種類のオペレーションをサポートしています。最初のオペレーションは、既存のエンティティを更新するためのアップサートです。2 つ目のオペレーションは、広告枠からエンティティを削除する削除です。どちらのオペレーションも、リクエスト本文にリストされている一連のエンティティに対して実行されます。1 回の API 呼び出しで最大 1,000 個のエンティティを更新できます。API は、受信したすべてのリクエストを受け取り、キューに入れてさらに処理します。そのため、RTU リクエストは非同期で処理されます。
Real-time updates API は、サンドボックス環境と本番環境の 2 つの環境で動作します。サンドボックス環境は API リクエストのテストに使用され、本番環境は Ordering End-to-End ユーザーに表示されるコンテンツを更新するために使用されます。両方の環境のホスト名:
サンドボックス - partnerdev-mapsbooking.googleapis.com
本番環境 - mapsbooking.googleapis.com
エンドポイント
リアルタイム更新 API は、在庫更新の受信リクエストを処理するために 2 つのエンドポイントを公開します。
# 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
エンティティの更新
広告枠のエンティティを更新するには、UPSERTエンドポイントを使用して HTTP POST リクエストを送信します。各 POST リクエストには、PARTNER_ID パラメータと、広告枠スキーマにリストされている任意のエンティティ タイプの構造化データを含む JSON ペイロードを含める必要があります。
{"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\" }"}]}}
/* 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.constserviceAccountJson=require('./service-account.json');// ACTION REQUIRED: Change this to your Partner ID received from Google.// The Partner ID is available on the Partner Portal.constPARTNER_ID=1234;constHOST={prod:'https://mapsbooking.googleapis.com',sandbox:'https://partnerdev-mapsbooking.googleapis.com'};// ACTION REQUIRED: Change to 'prod' for productionconstENV='sandbox';// Feed name for Order with Google including the version.constFEED_NAME='owg.v2';// Endpoint urlconsturl=`${HOST[ENV]}/v1alpha/inventory/partners/${PARTNER_ID}/feeds/${FEED_NAME}/record:batchPush`;/** * Send a Real-time update request to update/insert entities */asyncfunctionbatchUpsert(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 */constclient=newJWT({email:serviceAccountJson.client_email,key:serviceAccountJson.private_key,scopes:['https://www.googleapis.com/auth/mapsbooking'],});constrequest={records:toPushRecords(entities)};constbody=JSON.stringify(request);try{constresponse=awaitclient.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 */consttoPushRecords=(entities)=>{returnentities.map((entity)=>{// Using dateModified to set generation_timestamp. Defaulting to the// current timestamp for records that do not have dateModified.constgeneration_timestamp=entity.dateModified?entity.dateModified:newDate().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-authimportbase64importdatetimeimportjsonfromgoogle.auth.transport.requestsimportAuthorizedSessionfromgoogle.oauth2importservice_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)defbatch_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.htmlcredentials=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 objectbatch_request={'records':[create_push_record(x)forxinentities]}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 '{}'defcreate_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.dateModifiedif'dateModified'inentityelsedatetime.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'}])
/* * Required Libraries: * - JDK >= 11 * - google-auth-library-oauth2-http */packagertusamples;importcom.fasterxml.jackson.core.JsonProcessingException;importcom.fasterxml.jackson.databind.ObjectMapper;importcom.google.auth.oauth2.AccessToken;importcom.google.auth.oauth2.GoogleCredentials;importjava.io.FileInputStream;importjava.io.IOException;importjava.net.URI;importjava.net.http.HttpClient;importjava.net.http.HttpRequest;importjava.net.http.HttpRequest.BodyPublishers;importjava.net.http.HttpResponse;importjava.net.http.HttpResponse.BodyHandlers;importjava.nio.charset.Charset;importjava.time.Clock;importjava.time.OffsetDateTime;importjava.time.format.DateTimeFormatter;importjava.util.ArrayList;importjava.util.Arrays;importjava.util.Base64;importjava.util.List;importjava.util.Optional;importjava.util.stream.Collectors;importrtusamples.inventory.MenuItemOffer;importrtusamples.inventory.MenuItemOfferType;importrtusamples.inventory.ServiceTypeElement;importrtusamples.realtime.BatchPushGenericRecordRequest;importrtusamples.realtime.GenericRecord;/** Sample code for Real-time update batchPush implementation. */publicfinalclassBasicPush{// ACTION REQUIRED: Change this to your Partner ID received from Google. The Partner ID is// available on the Partner Portal.privatestaticfinallongPARTNER_ID=12345678;// ACTION REQUIRED: Change this to the path of the service account client secret file downloaded// from the Google Cloud Console.privatestaticfinalStringJSON_KEY_FULL_PATH="<path to your JSON credentials>/credentials.json";// ACTION REQUIRED: Change this to the endpoint that is needed.privatestaticfinalStringENDPOINT=// "https://partnerdev-mapsbooking.googleapis.com"; // for sandbox"https://mapsbooking.googleapis.com";// for prod// Feed name for Order with Google including the version.privatestaticfinalStringFEED_NAME="owg.v2";privatestaticfinalObjectMapperobjectMapper=newObjectMapper();privatestaticfinalDateTimeFormatterTIMESTAMP_FORMATTER=DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss[.SSS]'Z'");privatestaticfinalCharsetUTF_8=Charset.forName("UTF-8");publicstaticvoidmain(String[]args)throwsException{/** * 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);GoogleCredentialscredentials=GoogleCredentials.fromStream(newFileInputStream(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.MenuItemOffermenuItemOfferPizza=newMenuItemOffer();menuItemOfferPizza.setID("6680261");menuItemOfferPizza.setType(MenuItemOfferType.MENU_ITEM_OFFER);menuItemOfferPizza.setMenuItemID("18931508");menuItemOfferPizza.setPrice(15.5);menuItemOfferPizza.setPriceCurrency("USD");menuItemOfferPizza.setApplicableServiceType(newServiceTypeElement[]{ServiceTypeElement.TAKEOUT,ServiceTypeElement.DELIVERY});menuItemOfferPizza.setInventoryLevel(0.0);menuItemOfferPizza.setDateModified("2022-10-07T13:00:00.000Z");MenuItemOffermenuItemOfferSalad=newMenuItemOffer();menuItemOfferSalad.setID("6680262");menuItemOfferSalad.setType(MenuItemOfferType.MENU_ITEM_OFFER);menuItemOfferSalad.setMenuItemID("18931509");menuItemOfferSalad.setPrice(25.5);menuItemOfferSalad.setPriceCurrency("USD");menuItemOfferSalad.setApplicableServiceType(newServiceTypeElement[]{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=newArrayList<>();// Add list of menuItemOffer generic records.recordsToBeUpdated.addAll(menuItemOfferGenericRecords);// Request object that contains all records.BatchPushGenericRecordRequestbatchPushRequest=newBatchPushGenericRecordRequest();batchPushRequest.setRecords(recordsToBeUpdated.toArray(newGenericRecord[0]));// Execute batchPush request.BasicPushbasicPush=newBasicPush();basicPush.batchPush(batchPushRequest,credentials);}publicvoidbatchPush(BatchPushGenericRecordRequestbatchPushRequest,GoogleCredentialscredentials)throwsIOException{credentials.refreshIfExpired();AccessTokentoken=credentials.getAccessToken();StringrequestBody=objectMapper.writeValueAsString(batchPushRequest);HttpClientclient=HttpClient.newHttpClient();HttpRequestrequest=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|InterruptedExceptione){e.printStackTrace();}}publicstatic<T>GenericRecordtoBatchPushRecord(Tentity,StringdateModified){GenericRecordgenericRecord=newGenericRecord();try{Stringjson=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.StringgenerationTimestamp=Optional.ofNullable(dateModified).orElse(OffsetDateTime.now(Clock.systemUTC()).format(TIMESTAMP_FORMATTER));genericRecord.setGenerationTimestamp(generationTimestamp);}catch(JsonProcessingExceptione){System.out.println(e.getMessage());}returngenericRecord;}}
/* 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.constserviceAccountJson=require('./service-account.json');// ACTION REQUIRED: Change this to your Partner ID received from Google.// The Partner ID is available on the Partner Portal.constPARTNER_ID=1234;constHOST={prod:'https://mapsbooking.googleapis.com',sandbox:'https://partnerdev-mapsbooking.googleapis.com'};// ACTION REQUIRED: Change to 'prod' for productionconstENV='sandbox';// Feed name for Order with Google including the version.constFEED_NAME='owg.v2';// Endpoint urlconsturl=`${HOST[ENV]}/v1alpha/inventory/partners/${PARTNER_ID}/feeds/${FEED_NAME}/record:batchDelete`;/** * Send a Real-time update request to delete entities */asyncfunctionbatchDelete(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 */constclient=newJWT({email:serviceAccountJson.client_email,key:serviceAccountJson.private_key,scopes:['https://www.googleapis.com/auth/mapsbooking'],});constrequest={records:toDeleteRecords(entities)};constbody=JSON.stringify(request);try{constresponse=awaitclient.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 */consttoDeleteRecords=(entities)=>{returnentities.map((entity)=>{// Using dateModified to set delete_time. Defaulting to the current// timestamp for records that do not have dateModified.constdelete_time=entity.dateModified?entity.dateModified:newDate().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-authimportbase64importdatetimeimportjsonfromgoogle.auth.transport.requestsimportAuthorizedSessionfromgoogle.oauth2importservice_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)defbatch_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.htmlcredentials=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 objectbatch_request={'records':[create_delete_record(x)forxinentities]}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 '{}'defcreate_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.dateModifiedif'dateModified'inentityelsedatetime.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'}])
/* * Required Libraries: * - JDK >= 11 * - google-auth-library-oauth2-http */packagertusamples;importcom.fasterxml.jackson.core.JsonProcessingException;importcom.fasterxml.jackson.databind.ObjectMapper;importcom.google.auth.oauth2.AccessToken;importcom.google.auth.oauth2.GoogleCredentials;importjava.io.FileInputStream;importjava.io.IOException;importjava.net.URI;importjava.net.http.HttpClient;importjava.net.http.HttpRequest;importjava.net.http.HttpRequest.BodyPublishers;importjava.net.http.HttpResponse;importjava.net.http.HttpResponse.BodyHandlers;importjava.nio.charset.Charset;importjava.time.Clock;importjava.time.OffsetDateTime;importjava.time.format.DateTimeFormatter;importjava.util.ArrayList;importjava.util.Arrays;importjava.util.Base64;importjava.util.List;importjava.util.Optional;importjava.util.stream.Collectors;importrtusamples.inventory.Menu;importrtusamples.inventory.MenuType;importrtusamples.realtime.BatchDeleteGenericRecordsRequest;importrtusamples.realtime.GenericDeleteRecord;/** Sample code for the Real-time update batchDelete implementation. */publicfinalclassBasicDelete{// ACTION REQUIRED: Change this to your Partner ID received from Google. The Partner ID is// available on the Partner Portal.privatestaticfinallongPARTNER_ID=123456789;// ACTION REQUIRED: Change this to the path of the service account client secret file downloaded// from the Google Cloud Console.privatestaticfinalStringJSON_KEY_FULL_PATH="<path to your JSON credentials>/credentials.json";// ACTION REQUIRED: Change this to the endpoint that is needed.privatestaticfinalStringENDPOINT="https://partnerdev-mapsbooking.googleapis.com";// for sandbox// "https://mapsbooking.googleapis.com" // for prod// Feed name for Order with Google including the version.privatestaticfinalStringFEED_NAME="owg.v2";privatestaticfinalObjectMapperobjectMapper=newObjectMapper();privatestaticfinalDateTimeFormatterTIMESTAMP_FORMATTER=DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss[.SSS]'Z'");privatestaticfinalCharsetUTF_8=Charset.forName("UTF-8");publicstaticvoidmain(String[]args)throwsException{/** * 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);GoogleCredentialscredentials=GoogleCredentials.fromStream(newFileInputStream(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.MenumenuLunch=newMenu();menuLunch.setID("853705");menuLunch.setType(MenuType.MENU);menuLunch.setDateModified("2022-09-19T13:10:00.000Z");MenumenuDinner=newMenu();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=newArrayList<>();// Add list of menu generic records.recordsToBeDeleted.addAll(menuGenericDeleteRecords);// Request object that contains all records.BatchDeleteGenericRecordsRequestbatchDeleteRequest=newBatchDeleteGenericRecordsRequest();batchDeleteRequest.setRecords(recordsToBeDeleted.toArray(newGenericDeleteRecord[0]));// Execute batchDelete request.BasicDeletebasicDelete=newBasicDelete();basicDelete.batchDelete(batchDeleteRequest,credentials);}publicvoidbatchDelete(BatchDeleteGenericRecordsRequestbatchDeleteRequest,GoogleCredentialscredentials)throwsIOException{credentials.refreshIfExpired();AccessTokentoken=credentials.getAccessToken();StringrequestBody=objectMapper.writeValueAsString(batchDeleteRequest);HttpClientclient=HttpClient.newHttpClient();HttpRequestrequest=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|InterruptedExceptione){e.printStackTrace();}}publicstatic<T>GenericDeleteRecordtoBatchDeleteRecord(Tentity,StringdateModified){GenericDeleteRecordgenericRecord=newGenericDeleteRecord();try{Stringjson=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.StringdeleteTime=Optional.ofNullable(dateModified).orElse(OffsetDateTime.now(Clock.systemUTC()).format(TIMESTAMP_FORMATTER));genericRecord.setDeleteTime(deleteTime);}catch(JsonProcessingExceptione){System.out.println(e.getMessage());}returngenericRecord;}}
ユースケース
次のユースケースは、リアルタイム更新、バッチ フィード更新、API 呼び出しの概要の例です。
シナリオ
更新するエンティティ
説明と影響
サービスの無効化
Service
予期しない理由でサービスを無効にする必要があります。
リアルタイム更新: 対象の Service エンティティの isDisabled プロパティを true に設定して更新します。他のプロパティは変更しません。
完全なフィード: Google による次回の取得前に、完全なフィードからエンティティを更新して isDisabled を true に設定してください。設定しない場合、エンティティは再度有効になります。
[null,null,["最終更新日 2024-11-26 UTC。"],[[["This API enables partners to send time-sensitive inventory updates to Google, reflecting changes in the Google UI within five minutes."],["It supports `upsert` and `delete` operations for up to 1,000 entities per API call, processing requests asynchronously via a queue."],["Include changes made via real-time updates in your daily data feeds to maintain data consistency and avoid overwrites."],["For adding new entities, use batch ingestion instead of real-time updates, as it is not designed for this purpose."],["The `generation_timestamp` field ensures updates within a `batchPush` request are applied in the correct order, facilitating entity versioning."]]],[]]
