REST Resource: accountTypes.accounts.userLists

संसाधन: UserList

उपयोगकर्ता सूची का संसाधन.

JSON के काेड में दिखाना 
{
  "name": string,
  "id": string,
  "readOnly": boolean,
  "membershipDuration": string,
  "accessReason": enum (AccessReason),
  "sizeInfo": {
    object (SizeInfo)
  },
  "targetNetworkInfo": {
    object (TargetNetworkInfo)
  },
  "displayName": string,
  "description": string,
  "membershipStatus": enum (MembershipStatus),
  "integrationCode": string,
  "closingReason": enum (ClosingReason),
  "accountAccessStatus": enum (AccessStatus),

  // Union field user_list_info can be only one of the following:
  "ingestedUserListInfo": {
    object (IngestedUserListInfo)
  }
  // End of list of possible types for union field user_list_info.
}
फ़ील्ड
name

string

आइडेंटिफ़ायर. उपयोगकर्ता सूची के संसाधन का नाम. फ़ॉर्मैट: accountTypes/{accountType}/accounts/{account}/userLists/{userList}
id

string (int64 format)

सिर्फ़ आउटपुट के लिए. उपयोगकर्ता सूची का यूनीक आईडी.
readOnly

boolean

सिर्फ़ आउटपुट के लिए. यह विकल्प बताता है कि कोई उपयोगकर्ता सूची में बदलाव कर सकता है या नहीं.
membershipDuration

string (Duration format)

ज़रूरी नहीं. वह अवधि जिसके दौरान कोई उपयोगकर्ता, उपयोगकर्ता सूची में बना रहता है. मान्य अवधि, 24 घंटे (86,400 सेकंड) के सटीक मल्टीपल होती हैं. ऐसी वैल्यू देने पर जो 24 घंटे का सटीक गुणज नहीं है, INVALID_ARGUMENT गड़बड़ी दिखेगी.

यह अवधि सेकंड में होती है. इसमें नौ दशमलव अंक तक हो सकते हैं. इसके आखिर में 's' होता है. उदाहरण: "3.5s".
accessReason

enum (AccessReason)

सिर्फ़ आउटपुट के लिए. इस खाते को सूची का ऐक्सेस देने की वजह.
sizeInfo

object (SizeInfo)

सिर्फ़ आउटपुट के लिए. अलग-अलग टारगेट नेटवर्क में, इस उपयोगकर्ता सूची में शामिल सदस्यों की अनुमानित संख्या.
targetNetworkInfo

object (TargetNetworkInfo)

ज़रूरी नहीं. अलग-अलग टारगेट नेटवर्क के लिए ज़रूरी शर्तों के बारे में जानकारी.
displayName

string

ज़रूरी है. उपयोगकर्ता सूची का डिसप्ले नेम.
description

string

ज़रूरी नहीं. उपयोगकर्ता सूची के बारे में जानकारी.
membershipStatus

enum (MembershipStatus)

ज़रूरी नहीं. इस उपयोगकर्ता सूची की सदस्यता की स्थिति.
integrationCode

string

ज़रूरी नहीं. बाहरी सिस्टम से मिला आईडी. इसका इस्तेमाल, उपयोगकर्ता सूची बेचने वाले लोग करते हैं. इससे वे अपने सिस्टम पर आईडी को एक-दूसरे से जोड़ पाते हैं.
closingReason

enum (ClosingReason)

सिर्फ़ आउटपुट के लिए. इस उपयोगकर्ता सूची की सदस्यता की स्थिति बंद होने की वजह.
accountAccessStatus

enum (AccessStatus)

ज़रूरी नहीं. इससे पता चलता है कि शेयर करने की यह सुविधा अब भी चालू है या नहीं. जब किसी उपयोगकर्ता सूची को उस खाते के साथ शेयर किया जाता है जिसके लिए यह फ़ील्ड सेट किया गया है, तो ENABLED दिखता है. बाद में, उपयोगकर्ता सूची का मालिक, शेयर करने की सुविधा को बंद कर सकता है और इसे DISABLED के तौर पर सेट कर सकता है.
यूनियन फ़ील्ड user_list_info. उपयोगकर्ता सूची के बारे में ज़्यादा जानकारी. user_list_info इनमें से सिर्फ़ एक हो सकता है:
ingestedUserListInfo

object (IngestedUserListInfo)

ज़रूरी नहीं. यह ऐसी उपयोगकर्ता सूची को दिखाता है जिसमें उपयोगकर्ता के इनपुट किए गए डेटा से जानकारी भरी जाती है.

MembershipStatus

उपयोगकर्ता सूची की स्थिति.

Enums
MEMBERSHIP_STATUS_UNSPECIFIED जानकारी नहीं दी गई है.
OPEN खुली स्थिति - उपयोगकर्ता सूची में सदस्य जुड़ रहे हैं और इसे टारगेट किया जा सकता है.
CLOSED बंद है - कोई नया सदस्य नहीं जोड़ा जा रहा है.

ClosingReason

इससे यह पता चलता है कि उपयोगकर्ता सूची को क्यों बंद किया गया. इस enum का इस्तेमाल सिर्फ़ तब किया जाता है, जब सिस्टम किसी सूची को अपने-आप बंद कर देता है.

Enums
CLOSING_REASON_UNSPECIFIED जानकारी नहीं दी गई है.
UNUSED उपयोगकर्ता सूची को बंद कर दिया गया है, क्योंकि इसका इस्तेमाल हाल ही में टारगेटिंग के लिए नहीं किया गया है. ज़्यादा जानकारी के लिए, https://support.google.com/google-ads/answer/2472738 पर जाएं.

AccessReason

इस enum में, ऐक्सेस करने की संभावित वजहों के बारे में बताया गया है.

Enums
ACCESS_REASON_UNSPECIFIED जानकारी नहीं दी गई है.
OWNED इस संसाधन का मालिकाना हक उपयोगकर्ता के पास है.
SHARED उपयोगकर्ता के साथ संसाधन शेयर किया गया है.
LICENSED उपयोगकर्ता के पास रिसॉर्स का लाइसेंस है.
SUBSCRIBED उपयोगकर्ता ने संसाधन की सदस्यता ली है.
AFFILIATED उपयोगकर्ता के पास रिसॉर्स का ऐक्सेस है.

AccessStatus

इससे पता चलता है कि इस क्लाइंट के पास अब भी सूची का ऐक्सेस है या नहीं.

Enums
ACCESS_STATUS_UNSPECIFIED जानकारी नहीं दी गई है.
ENABLED ऐक्सेस चालू है.
DISABLED ऐक्सेस करने की सुविधा बंद है.

SizeInfo

अलग-अलग टारगेट नेटवर्क में, इस उपयोगकर्ता सूची में शामिल सदस्यों की अनुमानित संख्या.

JSON के काेड में दिखाना 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string,
  "youtubeMembersCount": string,
  "gmailMembersCount": string
}
फ़ील्ड
displayNetworkMembersCount

string (int64 format)

सिर्फ़ आउटपुट के लिए. Google Display Network पर, इस उपयोगकर्ता सूची में सदस्यों की अनुमानित संख्या.
searchNetworkMembersCount

string (int64 format)

सिर्फ़ आउटपुट के लिए. google.com डोमेन में, इस उपयोगकर्ता सूची में सदस्यों की अनुमानित संख्या. ये सदस्य, सर्च कैंपेन में टारगेटिंग के लिए उपलब्ध हैं.
youtubeMembersCount

string (int64 format)

सिर्फ़ आउटपुट के लिए. YouTube पर इस उपयोगकर्ता सूची में शामिल सदस्यों की अनुमानित संख्या.
gmailMembersCount

string (int64 format)

सिर्फ़ आउटपुट के लिए. Gmail पर इस उपयोगकर्ता सूची में सदस्यों की अनुमानित संख्या.

TargetNetworkInfo

अलग-अलग टारगेट नेटवर्क के लिए ज़रूरी शर्तों के बारे में जानकारी.

JSON के काेड में दिखाना 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
फ़ील्ड
eligibleForDisplay

boolean

सिर्फ़ आउटपुट के लिए. इससे पता चलता है कि यह उपयोगकर्ता सूची, Google Display Network के लिए ज़रूरी शर्तें पूरी करती है.

IngestedUserListInfo

यह उपयोगकर्ता की ऐसी सूची को दिखाता है जिसमें उपयोगकर्ता से मिले डेटा के आधार पर जानकारी भरी जाती है.

JSON के काेड में दिखाना 
{
  "uploadKeyTypes": [
    enum (UploadKeyType)
  ],
  "contactIdInfo": {
    object (ContactIdInfo)
  },
  "mobileIdInfo": {
    object (MobileIdInfo)
  },
  "userIdInfo": {
    object (UserIdInfo)
  },
  "pairIdInfo": {
    object (PairIdInfo)
  },
  "pseudonymousIdInfo": {
    object (PseudonymousIdInfo)
  },
  "partnerAudienceInfo": {
    object (PartnerAudienceInfo)
  }
}
फ़ील्ड
uploadKeyTypes[]

enum (UploadKeyType)

ज़रूरी है. इम्यूटेबल. इस उपयोगकर्ता सूची के अपलोड पासकोड टाइप.
contactIdInfo

object (ContactIdInfo)

ज़रूरी नहीं. CONTACT_ID के uploadKeyTypes में से एक होने पर अतिरिक्त जानकारी.
mobileIdInfo

object (MobileIdInfo)

ज़रूरी नहीं. MOBILE_ID के uploadKeyTypes में से एक होने पर अतिरिक्त जानकारी.
userIdInfo

object (UserIdInfo)

ज़रूरी नहीं. USER_ID के uploadKeyTypes में से एक होने पर अतिरिक्त जानकारी.
pairIdInfo

object (PairIdInfo)

ज़रूरी नहीं. PAIR_ID के uploadKeyTypes में से एक होने पर अतिरिक्त जानकारी.

यह सुविधा सिर्फ़ डेटा पार्टनर के लिए उपलब्ध है.
pseudonymousIdInfo

object (PseudonymousIdInfo)

ज़रूरी नहीं. PSEUDONYMOUS_ID के लिए अतिरिक्त जानकारी, uploadKeyTypes में से एक है.
partnerAudienceInfo

object (PartnerAudienceInfo)

ज़रूरी नहीं. पार्टनर ऑडियंस के लिए अतिरिक्त जानकारी.

यह सुविधा सिर्फ़ डेटा पार्टनर के लिए उपलब्ध है.

UploadKeyType

इस सूची में, उपयोगकर्ता सूची के अपलोड पासकोड के संभावित टाइप शामिल हैं.

Enums
UPLOAD_KEY_TYPE_UNSPECIFIED जानकारी नहीं दी गई है.
CONTACT_ID ग्राहक की जानकारी, जैसे कि ईमेल पता, फ़ोन नंबर या घर का पता.
MOBILE_ID मोबाइल ऐडवर्टाइज़िंग आईडी.
USER_ID तीसरे पक्ष की ओर से दिए गए उपयोगकर्ता आईडी.
PAIR_ID विज्ञापन देने वाले व्यक्ति या कंपनी की पहचान की पुष्टि करने के लिए, पब्लिशर के आईडी.
PSEUDONYMOUS_ID डेटा मैनेजमेंट प्लैटफ़ॉर्म आईडी: - Google उपयोगकर्ता आईडी - पार्टनर का दिया गया आईडी - पब्लिशर का दिया गया आईडी - iOS आईडीएफ़ए - Android विज्ञापन आईडी - Roku आईडी - Amazon Fire TV आईडी - Xbox या Microsoft आईडी

ContactIdInfo

CONTACT_ID के uploadKeyTypes में से एक होने पर अतिरिक्त जानकारी.

JSON के काेड में दिखाना 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
फ़ील्ड
matchRatePercentage

integer

सिर्फ़ आउटपुट के लिए. कस्टमर मैच के लिए बनाई गई लोगों की लिस्ट का मैच रेट.
dataSourceType

enum (DataSourceType)

ज़रूरी नहीं. इम्यूटेबल. अपलोड किए गए डेटा का सोर्स

DataSourceType

इससे अपलोड किए गए डेटा के सोर्स का पता चलता है.

Enums
DATA_SOURCE_TYPE_UNSPECIFIED जानकारी नहीं दी गई है.
DATA_SOURCE_TYPE_FIRST_PARTY अपलोड किया गया डेटा, पहले पक्ष (ग्राहक) का डेटा है.
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU अपलोड किया गया डेटा, तीसरे पक्ष के क्रेडिट ब्यूरो से लिया गया है.
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE अपलोड किया गया डेटा, तीसरे पक्ष की वोटर फ़ाइल से लिया गया हो.
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA अपलोड किया गया डेटा, तीसरे पक्ष के पार्टनर का डेटा है.

MobileIdInfo

MOBILE_ID के uploadKeyTypes में से एक होने पर अतिरिक्त जानकारी.

JSON के काेड में दिखाना 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
फ़ील्ड
dataSourceType

enum (DataSourceType)

ज़रूरी नहीं. इम्यूटेबल. अपलोड किए गए डेटा का सोर्स.
keySpace

enum (KeySpace)

ज़रूरी है. इम्यूटेबल. मोबाइल आईडी का मुख्य स्पेस.
appId

string

ज़रूरी है. इम्यूटेबल. यह एक स्ट्रिंग होती है, जो उस मोबाइल ऐप्लिकेशन की यूनीक तरीके से पहचान करती है जिससे डेटा इकट्ठा किया गया था.

KeySpace

मोबाइल आईडी के लिए मुख्य स्पेस.

Enums
KEY_SPACE_UNSPECIFIED जानकारी नहीं दी गई है.
IOS iOS कीस्पेस.
ANDROID Android का कीस्पेस.

UserIdInfo

USER_ID के uploadKeyTypes में से एक होने पर अतिरिक्त जानकारी.

JSON के काेड में दिखाना 
{
  "dataSourceType": enum (DataSourceType)
}
फ़ील्ड
dataSourceType

enum (DataSourceType)

ज़रूरी नहीं. इम्यूटेबल. अपलोड किए गए डेटा का सोर्स.

PairIdInfo

PAIR_ID के uploadKeyTypes में से एक होने पर अतिरिक्त जानकारी.

यह सुविधा सिर्फ़ डेटा पार्टनर के लिए उपलब्ध है.

JSON के काेड में दिखाना 
{
  "publisherId": string,
  "publisherName": string,
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "cleanRoomIdentifier": string
}
फ़ील्ड
publisherId

string (int64 format)

ज़रूरी है. इम्यूटेबल. इस कुकी से उस पब्लिशर की पहचान होती है जिसके साथ, Publisher Advertiser Identity Reconciliation की सुविधा का इस्तेमाल करने वाली उपयोगकर्ता सूची को फिर से मिलाया जाता है. यह फ़ील्ड, क्लीनरूम की सुविधा देने वाली कंपनी उपलब्ध कराती है. यह सिर्फ़ उस क्लीनरूम के दायरे में यूनीक होता है. इसका इस्तेमाल, एक से ज़्यादा क्लीनरूम में ग्लोबल आइडेंटिफ़ायर के तौर पर नहीं किया जा सकता.
publisherName

string

ज़रूरी है. पब्लिशर का ऐसा नाम जिसे यूज़र इंटरफ़ेस (यूआई) में दिखाया जा सके, ताकि टारगेटिंग का बेहतर अनुभव मिल सके.
matchRatePercentage

integer

ज़रूरी है. इस फ़ील्ड से पता चलता है कि उपयोगकर्ता की इस सूची में शामिल लोगों की सदस्यता, पब्लिशर के पहले पक्ष (ग्राहक) के डेटा से कितने प्रतिशत तक मैच करती है. यह 0 और 100 के बीच होना चाहिए.
advertiserIdentifierCount

string (int64 format)

ज़रूरी नहीं. विज्ञापन देने वाले व्यक्ति या कंपनी के पहले पक्ष के डेटा के उन रिकॉर्ड की संख्या जिन्हें क्लीन रूम की सेवा देने वाली कंपनी के पास अपलोड किया गया है. इससे PAIR उपयोगकर्ता सूची के साइज़ का पता नहीं चलता.
cleanRoomIdentifier

string

ज़रूरी है. इम्यूटेबल. यह कुकी, विज्ञापन देने वाले व्यक्ति या कंपनी और पब्लिशर के बीच यूनीक संबंध की पहचान करती है. यह संबंध, एक क्लीन रूम प्रोवाइडर या कई क्लीन रूम प्रोवाइडर के साथ हो सकता है.

PseudonymousIdInfo

PSEUDONYMOUS_ID के uploadKeyTypes में से एक होने पर अतिरिक्त जानकारी.

JSON के काेड में दिखाना 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
फ़ील्ड
syncStatus

enum (SyncStatus)

सिर्फ़ आउटपुट के लिए. उपयोगकर्ता सूची के सिंक होने की स्थिति.
billableRecordCount

string (int64 format)

ज़रूरी नहीं. इम्यूटेबल. बिल किए जा सकने वाले रिकॉर्ड की संख्या. जैसे, अपलोड किए गए या मैच किए गए रिकॉर्ड.

SyncStatus

उपयोगकर्ता सूची के सिंक होने की स्थिति.

Enums
SYNC_STATUS_UNSPECIFIED जानकारी नहीं दी गई है.
CREATED उपयोगकर्ता सूची को प्लेसहोल्डर के तौर पर बनाया गया है. सूची का कॉन्टेंट और/या मेटाडेटा अब भी सिंक हो रहा है. उपयोगकर्ता सूची का इस्तेमाल नहीं किया जा सकता.
READY_FOR_USE उपयोगकर्ता सूची का इस्तेमाल किया जा सकता है. कॉन्टेंट और कुकी को सही तरीके से सिंक किया गया हो.
FAILED उपयोगकर्ता सूची के कॉन्टेंट और/या मेटाडेटा को सिंक करने में कोई गड़बड़ी हुई है. उपयोगकर्ता सूची का इस्तेमाल नहीं किया जा सकता.

PartnerAudienceInfo

पार्टनर ऑडियंस के लिए अतिरिक्त जानकारी.

यह सुविधा सिर्फ़ डेटा पार्टनर के लिए उपलब्ध है.

JSON के काेड में दिखाना 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
फ़ील्ड
partnerAudienceSource

enum (PartnerAudienceSource)

ज़रूरी है. इम्यूटेबल. यह पार्टनर ऑडियंस का सोर्स होता है.
commercePartner

string

ज़रूरी नहीं. कॉमर्स पार्टनर का नाम. इसकी अनुमति सिर्फ़ तब होती है, जब partnerAudienceSource COMMERCE_AUDIENCE हो.

PartnerAudienceSource

पार्टनर ऑडियंस सोर्स.

Enums
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED जानकारी नहीं दी गई है.
COMMERCE_AUDIENCE पार्टनर ऑडियंस सोर्स, कॉमर्स ऑडियंस है.
LINEAR_TV_AUDIENCE पार्टनर ऑडियंस सोर्स, लीनियर टीवी ऑडियंस है.
AGENCY_PROVIDER_AUDIENCE पार्टनर ऑडियंस का सोर्स, एजेंसी/प्रोवाइडर ऑडियंस है.

तरीके

create

 यह UserList बनाता है.

delete

 यह UserList को मिटाता है.

get

 UserList ऑब्जेक्ट को वापस लाता है.

list

 UserLists को लिस्ट करता है.

patch

 UserList को अपडेट करता है.