Method: accounts.invitations.list

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

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

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

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

पाथ पैरामीटर

पैरामीटर
parent

string

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

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

पैरामीटर
filter

string

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

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

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

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

AccessControl.ListInvitations के लिए जवाब का मैसेज.

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
फ़ील्ड
invitations[]

object (Invitation)

खाते के लिए लंबित आमंत्रणों का कलेक्शन. यहां दिए गए न्योतों की संख्या 1,000 से ज़्यादा नहीं हो सकती.

अनुमति पाने के लिंक

नीचे दिए गए OAuth अनुमति की ज़रूरत हाेती है:

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

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

Invitation

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

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,
  "placeId": string
}
फ़ील्ड
locationName

string

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

string

उस जगह का पता जहां उपयोगकर्ता को न्योता भेजा गया है. यह हमेशा नहीं दिखता.
placeId

string

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

TargetType

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

Enums
TARGET_TYPE_UNSPECIFIED यह कुकी तब सेट की जाती है, जब टारगेट टाइप की जानकारी नहीं दी जाती है.
ACCOUNTS_ONLY सिर्फ़ खाता टाइप के टारगेट के लिए न्योते की सूची बनाएं.
LOCATIONS_ONLY सिर्फ़ लोकेशन टाइप के टारगेट के लिए न्योते की सूची.