Package google.mybusiness.placeactions.v1

इंडेक्स

PlaceActions

यह एपीआई, कारोबार की जगहों केplaceAction लिंक को मैनेज करने की सुविधा देता है.

ListPlaceActionTypeMetadata

rpc ListPlaceActionTypeMetadata(ListPlaceActionTypeMetadataRequest) returns (ListPlaceActionTypeMetadataResponse)

किसी जगह या देश के लिए, जगह के हिसाब से की जाने वाली कार्रवाइयों की सूची दिखाता है.

अनुमति देने के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/business.manage

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.

CreatePlaceActionLinkRequest

प्लेसमेंट कार्रवाइयों के लिए अनुरोध के मैसेज.CreatePlaceActionLink.

फ़ील्ड
parent

string

ज़रूरी है. उस जगह के संसाधन का नाम जहां इस जगह से जुड़ी कार्रवाई का लिंक बनाना है. locations/{location_id}.

DeletePlaceActionLinkRequest

प्लेसमेंट कार्रवाइयों के लिए अनुरोध का मैसेज.

फ़ील्ड
name

string

ज़रूरी है. जगह से जुड़ी कार्रवाई का लिंक, जिसे किसी जगह से हटाना है उसका संसाधन नाम.

ErrorCode

अंदरूनी गड़बड़ियों के लिए गड़बड़ी कोड.

Enums
ERROR_CODE_UNSPECIFIED अनजान गड़बड़ी कोड.
UNVERIFIED_LOCATION जगह की पुष्टि नहीं हुई है.
INVALID_LOCATION_CATEGORY जगह की कैटगरी, जगह से जुड़ी कार्रवाई के टाइप के लिए सही नहीं है. गड़बड़ी की वजह से होने वाली कार्रवाई का टाइप मेटाडेटा में दिखाया जाएगा. इसमें "place_action_type" स्ट्रिंग, कुंजी के तौर पर और PlaceActionType enum वैल्यू स्ट्रिंग, वैल्यू के तौर पर शामिल की जाएगी.
INVALID_URL यूआरएल गलत/अमान्य है. गलत जगह कार्रवाई यूआरएल को मेटाडेटा में दिखाया जाएगा, जिसमें "url" स्ट्रिंग को कुंजी और यूआरएल को वैल्यू के तौर पर दिखाया जाएगा.
URL_PROVIDER_NOT_ALLOWED यूआरएल में एक प्रोवाइडर है, जिसकी अनुमति नहीं है. जिस कार्रवाई की अनुमति नहीं है उसका यूआरएल मेटाडेटा में दिखाया जाएगा. इसमें स्ट्रिंग "url" कुंजी के तौर पर और यूआरएल को वैल्यू के तौर पर शामिल किया जाएगा.
TOO_MANY_VALUES जगह से जुड़ी कार्रवाई के प्रकार के लिए बहुत सारी वैल्यू सेट की गई हैं. जिस टाइप के लिए सीमा पूरी हुई है वह मेटाडेटा में दिखाया जाएगा. इसमें "place_action_type" स्ट्रिंग, कुंजी के तौर पर और PlaceActionType enum वैल्यू स्ट्रिंग को वैल्यू के तौर पर शामिल किया जाएगा.

GetPlaceActionLinkRequest

Plan Actions.GetPlaceActionLink के लिए मैसेज का अनुरोध करें.

फ़ील्ड
name

string

ज़रूरी है. फ़ेच करने के लिए कार्रवाई करने के लिंक का नाम.

ListPlaceActionLinksRequest

प्लेसमेंट कार्रवाइयों.ListPlaceActionLinks के लिए अनुरोध वाला मैसेज. इसमें किसी जगह के लिए, कार्रवाई करने के लिंक को किसी खास क्रम में शामिल नहीं किया जाएगा. ऐसा हो सकता है कि आप उन लिंक को न दिखाएं जो हाल ही में (पिछले 24 घंटे के अंदर) बनाए गए हैं और जो दूसरे प्लैटफ़ॉर्म जैसे कि Google MyBusiness की वेबसाइट से बनाए गए हैं. 24 घंटे से पहले बनाया गया कोई भी लिंक, इस एपीआई का इस्तेमाल करके दिखेगा.

फ़ील्ड
parent

string

ज़रूरी है. उस जगह का नाम जहां कार्रवाई करने के लिंक सूची में शामिल किए जाएंगे. locations/{location_id}.

filter

string

ज़रूरी नहीं. एक फ़िल्टर, जो वापस आने के लिए जगह की कार्रवाई से जुड़े लिंक को रोकता है. जवाब में, फ़िल्टर से मैच करने वाली एंट्री शामिल होती हैं. हम सिर्फ़ इस फ़िल्टर के साथ काम करते हैं: 1. place_action_type=XYZ में XYZ एक मान्य “placeActionType होता है”.

page_size

int32

ज़रूरी नहीं. हर पेज पर लौटाने के लिए, कार्रवाई के कितने लिंक हैं. डिफ़ॉल्ट वैल्यू 10. कम से कम एक वैल्यू होनी चाहिए.

page_token

string

ज़रूरी नहीं. अगर बताया गया हो, तो कार्रवाई के लिंक का अगला पेज दिखाता है.

ListPlaceActionLinksResponse

प्लेस एक्शन के लिए जवाब में भेजा गया मैसेज.

फ़ील्ड
next_page_token

string

अगर अनुरोध किए गए पेज के साइज़ से ज़्यादा जगह कार्रवाई के लिंक हैं, तो इस फ़ील्ड को एक टोकन से भर दिया जाता है, ताकि नतीजों का अगला पेज फ़ेच किया जा सके.

ListPlaceActionTypeMetadataRequest

प्लेसमेंट कार्रवाइयों के लिए अनुरोध के मैसेज.ListPlaceActionTypeMetadata. नतीजे किसी खास क्रम में नहीं दिखाए जाएंगे.

फ़ील्ड
language_code

string

ज़रूरी नहीं. डिसप्ले नेम पाने के लिए, भाषा का IETF BCP-47 कोड. अगर यह भाषा उपलब्ध नहीं है, तो इसे अंग्रेज़ी में उपलब्ध कराया जाएगा.

page_size

int32

ज़रूरी नहीं. हर पेज पर कितनी तरह की कार्रवाई शामिल की जानी चाहिए. डिफ़ॉल्ट संख्या 10 और कम से कम 1 होती है.

page_token

string

ज़रूरी नहीं. अगर तय किया गया है, तो जगह से जुड़ी कार्रवाई के प्रकार के मेटाडेटा का अगला पेज फिर से लाया जाता है. जब placeActionTypeMetadata.list को कॉल करने पर, अनुरोध किए गए पेज साइज़ से ज़्यादा नतीजे मिलते हैं, तब pageToken दिखाया जाता है.

filter

string

ज़रूरी नहीं. एक फ़िल्टर, जो जगह की कार्रवाइयों के टाइप को सीमित करता है, ताकि उसका मेटाडेटा दिखाया जा सके. जवाब में, फ़िल्टर से मैच करने वाली एंट्री शामिल होती हैं. हम सिर्फ़ इन फ़िल्टर के साथ काम करते हैं: 1. location=XYZ जहां XYZ किसी जगह के संसाधन का नाम दिखाने वाली स्ट्रिंग होती है, जो locations/{location_id} फ़ॉर्मैट में होती है. 2. region_code=XYZ में उपलब्ध कार्रवाई टाइप खोजने के लिए, XYZ एक यूनिकोड CLDR क्षेत्र कोड होता है.

अगर कोई फ़िल्टर नहीं दिया गया है, तो जगह पर की जाने वाली सभी कार्रवाइयां दिखेंगी.

ListPlaceActionTypeMetadataResponse

स्थान कार्रवाइयों.ListPlaceActionTypeMetadata के लिए जवाब का मैसेज.

फ़ील्ड
place_action_type_metadata[]

PlaceActionTypeMetadata

जगह पर की जाने वाली कार्रवाइयों के लिए उपलब्ध मेटाडेटा का कलेक्शन.

next_page_token

string

अगर कार्रवाई के टाइप की संख्या, अनुरोध किए गए पेज के साइज़ से ज़्यादा है, तो इस फ़ील्ड को एक टोकन से भर दिया जाएगा. ऐसा placeActionTypeMetadata.list के बाद किए जाने वाले कॉल पर अगले पेज को फ़ेच करने के लिए किया जाएगा. अगर कोई और नतीजा नहीं मिलता, तो जवाब में यह फ़ील्ड मौजूद नहीं होगा.

ProviderType

लिंक देने वाली कंपनी का टाइप, सिर्फ़ पढ़ा जा सकता है.

Enums
PROVIDER_TYPE_UNSPECIFIED जानकारी नहीं दी गई.
MERCHANT पहले पक्ष के तौर पर काम करने वाली कंपनी, जैसे कि व्यापारी/कंपनी या व्यापारी/कंपनी की तरफ़ से कोई एजेंसी.
AGGREGATOR_3P 3P एग्रीगेटर, जैसे कि Reserve with Google पार्टनर.

PlaceActionType

लिंक का इस्तेमाल करके किस तरह की कार्रवाई की जा सकती है.

Enums
PLACE_ACTION_TYPE_UNSPECIFIED जानकारी नहीं दी गई.
APPOINTMENT कार्रवाई का टाइप, अपॉइंटमेंट बुक करना है.
ONLINE_APPOINTMENT कार्रवाई का टाइप, ऑनलाइन अपॉइंटमेंट बुक करना है.
DINING_RESERVATION कार्रवाई का मतलब डाइनिंग बुकिंग करना है.
FOOD_ORDERING कार्रवाई का टाइप, खाना डिलीवर करने और/या घर ले जाने के लिए ऑर्डर करना है.
FOOD_DELIVERY कार्रवाई का टाइप, खाना डिलीवर करने के लिए ऑर्डर करना है.
FOOD_TAKEOUT कार्रवाई की मदद से, खाना पैक कराकर ले जाने की सुविधा है.
SHOP_ONLINE कार्रवाई का मतलब शॉपिंग है. यह डिलीवरी और/या पिकअप की सुविधा हो सकती है.

PlaceActionTypeMetadata

जगह के लिए तय की गई कार्रवाइयों का मेटाडेटा.

फ़ील्ड
place_action_type

PlaceActionType

जगह की कार्रवाई का टाइप.

display_name

string

अगर एट्रिब्यूट उपलब्ध है, तो उसके लिए स्थानीय भाषा में लिखा गया डिसप्ले नेम. अगर ऐसा नहीं है, तो अंग्रेज़ी में डिसप्ले नेम.

UpdatePlaceActionLinkRequest

Places Actions.UpdatePlaceActionLink के लिए अनुरोध वाला मैसेज.

फ़ील्ड
update_mask

FieldMask

ज़रूरी है. वे फ़ील्ड जिन्हें अपडेट करना है. सिर्फ़ uri, place_action_type, और is_preferred फ़ील्ड में बदलाव किया जा सकता है. अगर अपडेट किया गया लिंक पहले से ही place_action_type और uri वाले एक ही जगह पर मौजूद है, तो ALREADY_EXISTS गड़बड़ी दिखेगी.