মার্চেন্ট API অঞ্চল বলতে এমন ভৌগোলিক অঞ্চলকে বোঝায় যা আপনি accounts.products.regionalInventories রিসোর্সের সাথে সম্পর্কিত টার্গেট হিসেবে
ব্যবহার করতে পারবেন। আপনি
পোস্টাল কোডের সংগ্রহ হিসেবে অথবা কিছু দেশে, আগে থেকে নির্ধারিত জিওটার্গেট ব্যবহার করে
অঞ্চল নির্ধারণ করতে পারেন। আরও তথ্যের জন্য, অঞ্চল
সেট-আপ করুন।
Merchant API আপনার অঞ্চল ম্যানেজ করার জন্য ব্যাচ এন্ডপয়েন্ট প্রদান করে, যা আপনাকে একটি API কলের মাধ্যমে সর্বাধিক ১০০টি অঞ্চল তৈরি, আপডেট ও মুছে ফেলার অনুমতি দেয়। এটি আঞ্চলিক উপলভ্যতা ও দাম (RAAP) স্কেলে ম্যানেজ করা, দক্ষতা উন্নত করা এবং ইন্টিগ্রেশন সহজ করার জন্য আদর্শ।
এক নজরে
Batch API আপনাকে সংশ্লিষ্ট পদ্ধতির মাধ্যমে নিম্নলিখিত কাজগুলি করতে দেয়:
- একটি অনুরোধে একাধিক অঞ্চল তৈরি করুন:
regions:batchCreate - একসাথে একাধিক অঞ্চল মুছুন:
regions:batchDelete - একসাথে একাধিক অঞ্চল আপডেট করুন:
regions:batchUpdate
পূর্বশর্ত
সব ব্যাচ অনুরোধের জন্য যাচাইকরণ করতে ADMIN ব্যবহারকারীর ভূমিকা প্রয়োজন।
একাধিক অঞ্চল তৈরি করুন
এই উদাহরণে দেখানো হয়েছে যে কীভাবে BatchCreateRegions-এর একটি কলে দুটি নতুন অঞ্চল তৈরি করা যায় — একটি পিন কোড দ্বারা সংজ্ঞায়িত
এবং অন্যটি জিও টার্গেটিং দ্বারা।
অনুরোধ করুন
অনুরোধের URL এইভাবে তৈরি করুন:
POST
https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/regions:batchCreate
অনুরোধের বডিতে requests-এর একটি তালিকা থাকে, যেখানে প্রতিটি অবজেক্ট একটি
regionId এবং তৈরি করার জন্য region ডেটা নির্দিষ্ট করে।
{
"requests": [
{
"regionId": "seattle-area-98340",
"region": {
"displayName": "Seattle Region",
"postalCodeArea": {
"regionCode": "US",
"postalCodes": [
{
"begin": "98340"
}
]
}
}
},
{
"regionId": "co-de-states",
"region": {
"displayName": "Colorado and Delaware",
"geoTargetArea": {
"geotargetCriteriaIds": [
"21138",
"21141"
]
}
}
}
]
}
রেসপন্স
অনুরোধ সফল হলে নতুন region অবজেক্টের তালিকা দেখায়।
{
"regions": [
{
"name": "accounts/{ACCOUNT_ID}/regions/seattle-area-98340",
"displayName": "Seattle Region",
"postalCodeArea": {
"regionCode": "US",
"postalCodes": [
{
"begin": "98340"
}
]
},
"regionalInventoryEligible": true,
"shippingEligible": true
},
{
"name": "accounts/{ACCOUNT_ID}/regions/co-de-states",
"displayName": "Colorado and Delaware",
"geotargetArea": {
"geotargetCriteriaIds": [
"21138",
"21141"
]
},
"regionalInventoryEligible": false,
"shippingEligible": false
}
]
}
নিম্নলিখিত স্যাম্পেল থেকে জানা যায় যে ব্যাচ অনুরোধে কীভাবে একাধিক অঞ্চল তৈরি করতে হয়:
Java
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1.BatchCreateRegionsRequest;
import com.google.shopping.merchant.accounts.v1.BatchCreateRegionsResponse;
import com.google.shopping.merchant.accounts.v1.CreateRegionRequest;
import com.google.shopping.merchant.accounts.v1.Region;
import com.google.shopping.merchant.accounts.v1.Region.PostalCodeArea;
import com.google.shopping.merchant.accounts.v1.Region.PostalCodeArea.PostalCodeRange;
import com.google.shopping.merchant.accounts.v1.RegionsServiceClient;
import com.google.shopping.merchant.accounts.v1.RegionsServiceSettings;
import java.util.ArrayList;
import java.util.List;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;
/** This class demonstrates how to create multiple regions for a Merchant Center account. */
public class BatchCreateRegionsSample {
private static String getParent(String accountId) {
return String.format("accounts/%s", accountId);
}
public static void batchCreateRegions(Config config, List<String> regionIds) throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the credentials retrieved above.
RegionsServiceSettings regionsServiceSettings =
RegionsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Creates parent to identify where to insert the regions.
String parent = getParent(config.getAccountId().toString());
// Calls the API and catches and prints any network failures/errors.
try (RegionsServiceClient regionsServiceClient =
RegionsServiceClient.create(regionsServiceSettings)) {
List<CreateRegionRequest> requests = new ArrayList<>();
for (String regionId : regionIds) {
requests.add(
CreateRegionRequest.newBuilder()
.setParent(parent)
.setRegionId(regionId)
.setRegion(
Region.newBuilder()
.setDisplayName("Region " + regionId)
.setPostalCodeArea(
PostalCodeArea.newBuilder()
.setRegionCode("US")
.addPostalCodes(
PostalCodeRange.newBuilder()
.setBegin("10001")
.setEnd("10282")
.build())
.build())
.build())
.build());
}
BatchCreateRegionsRequest request =
BatchCreateRegionsRequest.newBuilder().setParent(parent).addAllRequests(requests).build();
System.out.println("Sending Batch Create Regions request");
BatchCreateRegionsResponse response = regionsServiceClient.batchCreateRegions(request);
System.out.println("Inserted Regions Names below");
// The last part of the region name will be the ID of the region.
// Format: `accounts/{account}/region/{region}`
response.getRegionsList().forEach(region -> System.out.println(region.getName()));
} catch (Exception e) {
System.out.println(e);
}
}
public static void main(String[] args) throws Exception {
Config config = Config.load();
// The unique IDs of the regions to create.
List<String> regionIds = new ArrayList<>();
regionIds.add("REGION_1");
regionIds.add("REGION_2");
regionIds.add("REGION_3");
regionIds.add("REGION_4");
regionIds.add("REGION_5");
batchCreateRegions(config, regionIds);
}
}
একাধিক অঞ্চল আপডেট করুন
এই উদাহরণে দেখানো হয়েছে যে কীভাবে BatchUpdateRegions ব্যবহার করে আগে থেকে থাকা দুটি অঞ্চলের জন্য displayName
এবং postalCodeArea আপডেট করা যায়। টার্গেট করা অঞ্চল আপডেট করতে আপনাকে অবশ্যই region.name
দিতে হবে।
অনুরোধ করুন
অনুরোধের URL এইভাবে তৈরি করুন:
POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/regions:batchUpdate
অনুরোধের প্রধান অংশে requests-এর তালিকা রয়েছে। প্রতিটি অবজেক্টে আপডেট করার জন্য
region ডেটা উল্লেখ করতে হবে। region.name ফিল্ডে অবশ্যই আপডেট করার জন্য অঞ্চলের আইডি থাকতে হবে, যেমন,"98005"। রিসোর্সকে accounts/{ACCOUNT_ID}/regions/name-এর পরিবর্তে
name হিসেবে উল্লেখ করুন। পরিবর্তন করার জন্য ফিল্ডগুলি ঐচ্ছিক কিনা তা নির্দেশ করতে
updateMask অন্তর্ভুক্ত করা হচ্ছে।
{
"requests": [
{
"region": {
"name": "98005",
"displayName": "Seattle Updated Region",
"postalCodeArea": {
"regionCode": "US",
"postalCodes": [
{
"begin": "98330"
}
]
}
},
"updateMask": "displayName,postalCodeArea"
},
{
"region": {
"name": "07086",
"displayName": "NewYork Updated Region",
"postalCodeArea": {
"regionCode": "US",
"postalCodes": [
{
"begin": "11*"
}
]
}
},
"updateMask": "displayName,postalCodeArea"
}
]
}
রেসপন্স
অনুরোধ সফল হলে, আপডেট করা region অবজেক্টের তালিকা দেখানো হয়।
{
"regions": [
{
"name": "accounts/{ACCOUNT_ID}/regions/98005",
"displayName": "Seattle Updated Region",
"postalCodeArea": {
"regionCode": "US",
"postalCodes": [
{
"begin": "98330"
}
]
},
"regionalInventoryEligible": true,
"shippingEligible": true
},
{
"name": "accounts/{ACCOUNT_ID}/regions/07086",
"displayName": "NewYork Updated Region",
"postalCodeArea": {
"regionCode": "US",
"postalCodes": [
{
"begin": "11*"
}
]
},
"regionalInventoryEligible": true,
"shippingEligible": true
}
]
}
ব্যাচ অনুরোধে একাধিক অঞ্চল কীভাবে আপডেট করতে হয় তা নিম্নলিখিত স্যাম্পেল থেকে দেখানো হয়েছে:
Java
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.protobuf.FieldMask;
import com.google.shopping.merchant.accounts.v1.BatchUpdateRegionsRequest;
import com.google.shopping.merchant.accounts.v1.BatchUpdateRegionsResponse;
import com.google.shopping.merchant.accounts.v1.Region;
import com.google.shopping.merchant.accounts.v1.RegionsServiceClient;
import com.google.shopping.merchant.accounts.v1.RegionsServiceSettings;
import com.google.shopping.merchant.accounts.v1.UpdateRegionRequest;
import java.util.ArrayList;
import java.util.List;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;
/** This class demonstrates how to update multiple regions for a Merchant Center account. */
public class BatchUpdateRegionsSample {
private static String getParent(String accountId) {
return String.format("accounts/%s", accountId);
}
private static String getRegionName(String accountId, String regionId) {
return String.format("accounts/%s/regions/%s", accountId, regionId);
}
public static void batchUpdateRegions(Config config, List<String> regionIds) throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the credentials retrieved above.
RegionsServiceSettings regionsServiceSettings =
RegionsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Creates parent to identify where to update the regions.
String parent = getParent(config.getAccountId().toString());
String accountId = config.getAccountId().toString();
// Calls the API and catches and prints any network failures/errors.
try (RegionsServiceClient regionsServiceClient =
RegionsServiceClient.create(regionsServiceSettings)) {
List<UpdateRegionRequest> requests = new ArrayList<>();
for (String regionId : regionIds) {
requests.add(
UpdateRegionRequest.newBuilder()
.setRegion(
Region.newBuilder()
.setName(getRegionName(accountId, regionId))
.setDisplayName("Updated Region " + regionId)
.build())
.setUpdateMask(FieldMask.newBuilder().addPaths("display_name").build())
.build());
}
BatchUpdateRegionsRequest request =
BatchUpdateRegionsRequest.newBuilder().setParent(parent).addAllRequests(requests).build();
System.out.println("Sending Batch Update Regions request");
BatchUpdateRegionsResponse response = regionsServiceClient.batchUpdateRegions(request);
System.out.println("Updated Regions Names below");
// The last part of the region name will be the ID of the region.
// Format: `accounts/{account}/region/{region}`
response.getRegionsList().forEach(region -> System.out.println(region.getName()));
} catch (Exception e) {
System.out.println(e);
}
}
public static void main(String[] args) throws Exception {
Config config = Config.load();
// The unique IDs of the regions to update.
List<String> regionIds = new ArrayList<>();
regionIds.add("REGION_1");
regionIds.add("REGION_2");
regionIds.add("REGION_3");
regionIds.add("REGION_4");
regionIds.add("REGION_5");
batchUpdateRegions(config, regionIds);
}
}
একাধিক অঞ্চল মুছুন
আপনি একটি কলে একাধিক অঞ্চল মুছে ফেলতে পারবেন।
অনুরোধ করুন
এই উদাহরণে দেখানো হয়েছে কীভাবে BatchDeleteRegions ব্যবহার করে একটি কলে দুটি অঞ্চল মুছে ফেলা যায়।
POST
https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/regions:batchDelete
অনুরোধের বডিতে requests-এর একটি তালিকা আছে, যেখানে প্রতিটি অবজেক্ট মুছে ফেলার জন্য অঞ্চলের
name ("accounts/{ACCOUNT_ID}/regions/" ছাড়া) নির্দিষ্ট করে।
{
"requests":
[
{
"name": "98005"
},
{
"name": "07086"
}
]
}
রেসপন্স
অনুরোধ সফল হলে, রেসপন্স বডি খালি থাকে, যার অর্থ হল নির্দিষ্ট করা অঞ্চল মুছে দেওয়া হয়েছে (বা ছিল না)।
{}
নিম্নলিখিত স্যাম্পেল থেকে বোঝা যায় যে কীভাবে ব্যাচ অনুরোধে একাধিক অঞ্চল মুছে ফেলতে হয়:
Java
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1.BatchDeleteRegionsRequest;
import com.google.shopping.merchant.accounts.v1.DeleteRegionRequest;
import com.google.shopping.merchant.accounts.v1.RegionsServiceClient;
import com.google.shopping.merchant.accounts.v1.RegionsServiceSettings;
import java.util.ArrayList;
import java.util.List;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;
/** This class demonstrates how to delete multiple regions for a Merchant Center account. */
public class BatchDeleteRegionsSample {
private static String getParent(String accountId) {
return String.format("accounts/%s", accountId);
}
private static String getRegionName(String accountId, String regionId) {
return String.format("accounts/%s/regions/%s", accountId, regionId);
}
public static void batchDeleteRegions(Config config, List<String> regionIds) throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the credentials retrieved above.
RegionsServiceSettings regionsServiceSettings =
RegionsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Creates parent to identify where to delete the regions.
String parent = getParent(config.getAccountId().toString());
String accountId = config.getAccountId().toString();
// Calls the API and catches and prints any network failures/errors.
try (RegionsServiceClient regionsServiceClient =
RegionsServiceClient.create(regionsServiceSettings)) {
List<DeleteRegionRequest> requests = new ArrayList<>();
for (String regionId : regionIds) {
requests.add(
DeleteRegionRequest.newBuilder().setName(getRegionName(accountId, regionId)).build());
}
BatchDeleteRegionsRequest request =
BatchDeleteRegionsRequest.newBuilder().setParent(parent).addAllRequests(requests).build();
System.out.println("Sending Batch Delete Regions request");
regionsServiceClient.batchDeleteRegions(request);
System.out.println("Regions deleted successfully");
} catch (Exception e) {
System.out.println(e);
}
}
public static void main(String[] args) throws Exception {
Config config = Config.load();
// The unique IDs of the regions to delete.
List<String> regionIds = new ArrayList<>();
regionIds.add("REGION_1");
regionIds.add("REGION_2");
regionIds.add("REGION_3");
regionIds.add("REGION_4");
regionIds.add("REGION_5");
batchDeleteRegions(config, regionIds);
}
}
সীমাবদ্ধতা
শুরু করার আগে, এইসব নিয়ম মনে রাখবেন:
- অ্যাটমিক অপারেশন: ব্যাচ অনুরোধ হল অ্যাটমিক। ব্যাচের মধ্যে কোনও একটি অপারেশন ব্যর্থ হলে (যেমন, একটি অঞ্চল তৈরি করা না গেলে), পুরো ব্যাচটি ব্যর্থ হবে এবং কোনও পরিবর্তন করা হবে না। API, ব্যর্থতার কারণের বিবরণ সহ একটি সমস্যা রিটার্ন করবে।
- ব্যাচ সীমা: প্রতিটি ব্যাচ অনুরোধে সর্বাধিক ১০০টি অঞ্চল অপারেশন থাকতে পারে।
- কোটা: এই এন্ডপয়েন্টগুলি তাদের সিঙ্গেল-অপারেশন কাউন্টারপার্টের (
regions.create,regions.delete,regions.update) মতো একই কোটা গ্রুপ ব্যবহার করে।
সাধারণ সমস্যা ও ত্রুটি
এখানে কিছু সাধারণ সমস্যা এবং সেগুলির সমাধান দেওয়া হল।
"একটি ব্যাচে অনুরোধের সংখ্যা অনেক বেশি"
আপনার অনুরোধের অ্যারেতে অপারেশনের সংখ্যা ১০০-এর সীমা অতিক্রম করলে এই সমস্যা হয়।
"error":
{
"code": 400,
"message": "The number of requests in a batch is too large.",
"status": "INVALID_ARGUMENT"
}
এটি ঠিক করতে, আপনার অপারেশন ১০০ বা তার কম সংখ্যক একাধিক ব্যাচ অনুরোধে ভাগ করুন।
প্রয়োজনীয় ফিল্ড ফাঁকা রাখা যাবে না
প্রয়োজনীয় ফিল্ডে তথ্য না থাকলে এই সমস্যা হয়। সমস্যার মেসেজে অনুপস্থিত প্যারামিটার উল্লেখ করা থাকবে।
সমস্যার মেসেজগুলি নিচে দেওয়া হল:
batchCreate-এর জন্য:[regionId] Required parameter: regionIdbatchUpdate-এর জন্য:[region.name] Required field not provided.batchDelete-এর জন্য:[name] Required parameter: name
এটি সমাধান করতে, প্রতিটি অপারেশনে সব প্রয়োজনীয় ফিল্ড আছে কিনা তা যাচাই করুন। যেমন,
batchUpdate অনুরোধের প্রতিটি এন্ট্রিতে region.name অন্তর্ভুক্ত থাকতে হবে।
নিম্নলিখিত অনুরোধ পোস্ট করার ফলে একটি সমস্যা হয়েছে:
{
"requests":
[
{
"region":
{
"displayName": "An update without a region name"
},
"updateMask": "displayName"
}
]
}
"নির্দিষ্ট আইডি সহ অঞ্চল আগে থেকেই আছে"
আগে থেকেই আছে এমন regionId দিয়ে কোনও অঞ্চল তৈরি করার চেষ্টা করলে,
সমস্যা হয়।
সমস্যার মেসেজ হল [regionId] Region with specified id already exists.।
এটি ঠিক করতে, ব্যাচের মধ্যে সব regionId ভ্যালু অনন্য কিনা তা যাচাই করুন এবং
আগে থেকে থাকা অঞ্চলের সাথে যাতে কোনও বিরোধ না হয় তা দেখুন।
"region.name বা regionId ফিল্ডের জন্য ডুপ্লিকেট ভ্যালু পাওয়া গেছে"
আপনি যদি একটি ব্যাচ অনুরোধের মধ্যে একই আইডি সহ একাধিক অঞ্চল তৈরি বা আপডেট করার চেষ্টা করেন তাহলে একটি সমস্যা হয়।
সমস্যার মেসেজ হল Duplicate value found for field {fieldName} in this batch
request with value {duplicated_value}.।
এটি ঠিক করতে, একটি ব্যাচ অনুরোধের মধ্যে সব regionId (batchCreate-এর জন্য) বা region.name
(batchUpdate-এর জন্য) ভ্যালু অনন্য কিনা তা যাচাই করুন।
"আইটেম খুঁজে পাওয়া যায়নি"
batchUpdate ব্যবহার করার সময়, অনুরোধে উল্লেখ করা কোনও অঞ্চল যদি না থাকে,
তাহলে পুরো ব্যাচটি 404 NOT_FOUND সমস্যার সাথে ব্যর্থ হবে। এটি
batchDelete-এর থেকে আলাদা, যা অস্তিত্বহীন অঞ্চলের জন্য সফল হয়।
"error": {
"code": 404,
"message": "item not found",
"status": "NOT_FOUND"
}
এটি ঠিক করতে, অনুরোধ পাঠানোর আগে আপনি যেসব অঞ্চল আপডেট করার চেষ্টা করছেন সেগুলি আছে কিনা তা যাচাই করুন।