Method: accounts.invitations.list

यह डायलॉग बॉक्स खास खाते के लिए ऐसे न्योतों की सूची बनाता है जिनकी मंज़ूरी बाकी है.

एचटीटीपी अनुरोध

GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. उस खाते का नाम जिससे न्योतों की सूची ली जा रही है. accounts/{account_id}/invitations अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है

क्वेरी पैरामीटर

पैरामीटर
filter

string

ज़रूरी नहीं. न्योते.target_type फ़ील्ड की मदद से, जवाब को फ़िल्टर किया जा सकता है.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

AccessControl.List नंबर के लिए रिस्पॉन्स मैसेज.

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

JSON के काेड में दिखाना 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
फ़ील्ड
invitations[]

object (Invitation)

उन न्योतों का कलेक्शन जो इस खाते के लिए अब तक स्वीकार नहीं किए गए हैं. यहां दिए गए न्योतों की संख्या 1,000 से ज़्यादा नहीं हो सकती.

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

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

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

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

आमंत्रण

यह ऐसे न्योते को दिखाता है जिसे मंज़ूरी नहीं मिली है.

JSON के काेड में दिखाना 
{
  "name": string,
  "role": enum (AdminRole),
  "targetType": enum (TargetType),

  // Union field target can be only one of the following:
  "targetAccount": {
    object (Account)
  },
  "targetLocation": {
    object (TargetLocation)
  }
  // End of list of possible types for union field target.
}
फ़ील्ड
name

string

ज़रूरी है. न्योते के लिए संसाधन का नाम. accounts/{account_id}/invitations/{invitation_id}.
role

enum (AdminRole)

सिर्फ़ आउटपुट के लिए. खाते पर न्योता पाने वाले व्यक्ति की भूमिका.
targetType

enum (TargetType)

सिर्फ़ आउटपुट के लिए. इससे पता चलता है कि रिस्पॉन्स में कौनसे टारगेट टाइप दिखाने चाहिए.
यूनियन फ़ील्ड target. इससे पता चलता है कि यह न्योता किस टारगेट के लिए है. target इनमें से सिर्फ़ एक हो सकता है:
targetAccount

object (Account)

यह न्योता, कम इस्तेमाल होने वाले खाते के लिए है.
targetLocation

object (TargetLocation)

वह टारगेट जगह, जिसके लिए यह न्योता भेजा गया है.

TargetLocation

लंबित आमंत्रण के लिए लक्षित स्थान दिखाता है.

JSON के काेड में दिखाना 
{
  "locationName": string,
  "address": string
}
फ़ील्ड
locationName

string

उस जगह का नाम जहां उपयोगकर्ता को न्योता भेजा गया है.
address

string

उस जगह का पता जहां उपयोगकर्ता को न्योता भेजा गया है.

TargetType

न्योते का टारगेट किस तरह का है.

Enums
TARGET_TYPE_UNSPECIFIED टारगेट टाइप की जानकारी न होने पर सेट करें.
ACCOUNTS_ONLY केवल खाता प्रकार के लक्ष्यों के लिए आमंत्रण सूचीबद्ध करें.
LOCATIONS_ONLY केवल स्थान प्रकार के लक्ष्यों के लिए आमंत्रणों की सूची बनाएं.