Method: accounts.invitations.list

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

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

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

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

पाथ के पैरामीटर

पैरामीटर
parent

string

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

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

पैरामीटर
filter

string

ज़रूरी नहीं. रिस्पॉन्स को फ़िल्टर करने के लिए, Subscription.target_type फ़ील्ड का इस्तेमाल किया जा सकता है.

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

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

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

AccessControl.Listन्योताs के लिए जवाब का मैसेज.

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

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

object (Invitation)

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

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

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

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

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

आमंत्रण

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

जेएसओएन के काेड में दिखाना 
{
  "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

मंज़ूरी बाकी वाले न्योते के लिए टारगेट की गई जगह के बारे में बताता है.

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

string

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

string

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

TargetType

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

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