REST Resource: customers.userLists

रिसॉर्स: उपयोगकर्ता सूची

यह Ads Data Hub से मैनेज की जाने वाली उपयोगकर्ता सूची के बारे में बताता है.

जेएसओएन के काेड में दिखाना 
{
  "name": string,
  "userListId": string,
  "adsDataCustomerId": string,
  "title": string,
  "description": string,
  "type": enum (UserListType),
  "createEmail": string,
  "listSize": string,
  "populateTime": string,
  "recipientAdsDataLinks": [
    string
  ],
  "state": enum (State),

  // Union field user_list can be only one of the following:
  "frequencyList": {
    object (FrequencyBasedListInfo)
  },
  "remarketingList": {
    object (RemarketingListInfo)
  }
  // End of list of possible types for union field user_list.
}
फ़ील्ड
name

string

सिर्फ़ आउटपुट. वह नाम जो Ads Data Hub की उपयोगकर्ता सूची की खास तौर पर पहचान करता है. इसमें ग्राहक/[customerId]/userLists/[userListId] फ़ॉर्म है
userListId

string (int64 format)

सिर्फ़ आउटपुट. उपयोगकर्ता सूची आईडी. यह फ़ील्ड, सेवा से जनरेट होता है और इसका इस्तेमाल UserList को पॉप्युलेट करने के लिए किया जाता है.
adsDataCustomerId

string (int64 format)

नहीं बदले जा सकते. इस उपयोगकर्ता सूची से जुड़ा, Ads Data Hub का ग्राहक आईडी जोड़ा गया. इस उपयोगकर्ता सूची का इस्तेमाल करके, UserListQuery की नौकरियां चलाते समय, इस आईडी को adsDataCustomerId के रूप में तय किया जाना चाहिए. अगर अभिभावक मौजूद नहीं है, तो पैरंट ग्राहक का इस्तेमाल किया जाएगा. सूची बनाने के बाद, इसे बदला नहीं जा सकता.
title

string

ज़रूरी है. उपयोगकर्ता सूची का शीर्षक, जो दिए गए AdsDataCustomerId के लिए यूनीक होता है.
description

string

ज़रूरी है. उपयोगकर्ता सूची का ब्यौरा.
type

enum (UserListType)

सिर्फ़ आउटपुट. उपयोगकर्ता सूची के प्रकार की वैल्यू, उपयोगकर्ता सूची के मुताबिक होनी चाहिए. इस वैल्यू को सिर्फ़ पढ़ा जा सकता है. साथ ही, इसे ऐक्सेस करने या सूची में शामिल करने के अनुरोध पर ऐक्सेस किया जा सकता है.
createEmail

string

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

string (int64 format)

सिर्फ़ आउटपुट. उपयोगकर्ता सूची में उपयोगकर्ताओं की संख्या. सूची के साइज़ को अपडेट करने में देरी हो सकती है.
populateTime

string (Timestamp format)

सिर्फ़ आउटपुट. वह समय जब सूची को पिछली बार भरा गया था.

RFC3339 यूटीसी और कोट के फ़ॉर्मैट;Zulu" में एक टाइमस्टैंप, जिसमें नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ दशमलव अंक हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
state

enum (State)

सिर्फ़ आउटपुट. उपयोगकर्ता सूची की स्थिति (चालू है/मिटाई गई). इस वैल्यू को सिर्फ़ पढ़ा जा सकता है. साथ ही, इसे ऐक्सेस करने या सूची में शामिल करने के अनुरोध पर ऐक्सेस किया जा सकता है.

यूनियन फ़ील्ड user_list. उपयोगकर्ता सूची के हिसाब से, ज़्यादा कॉन्फ़िगरेशन.

ठीक एक सेट होना चाहिए. user_list इनमें से सिर्फ़ एक हो सकता है:
frequencyList

object (FrequencyBasedListInfo)

फ़्रीक्वेंसी कैपिंग के लिए उपयोगकर्ता सूची.
remarketingList

object (RemarketingListInfo)

रीमार्केटिंग सूची.

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

उपयोगकर्ता सूची का प्रकार. टारगेटिंग के समय पर उपयोगकर्ता सूची बनाना और उसका इस्तेमाल इस ईनम पर निर्भर करता है. सूची बनाने के बाद उसका प्रकार बदला नहीं जा सकता.

Enums
USER_LIST_TYPE_UNSPECIFIED डिफ़ॉल्ट मान: इस्तेमाल नहीं किया जाना चाहिए.
REMARKETING ADH पर SQL क्वेरी से बनाई गई रीमार्केटिंग ऑडियंस. रीमार्केटिंग सूची का इस्तेमाल पॉज़िटिव और नेगेटिव टारगेटिंग के लिए किया जा सकता है.
FREQUENCY_BASED फ़्रीक्वेंसी सीमित ऑडियंस. इस तरह की ऑडियंस नेगेटिव टारगेटिंग तक सीमित हैं.

फ़्रीक्वेंसी आधारित सूची की जानकारी

फ़्रीक्वेंसी पर आधारित उपयोगकर्ता सूची के लिए मेटाडेटा.

जेएसओएन के काेड में दिखाना 
{
  "dv360LineitemIds": [
    string
  ],
  "cmCampaignIds": [
    string
  ],
  "googleAdsCampaignIds": [
    string
  ],
  "eventMatchers": [
    {
      object (EventMatcher)
    }
  ],
  "frequencyConstraint": {
    object (FrequencyConstraint)
  },
  "slidingWindowDays": integer
}
फ़ील्ड
dv360LineitemIds[]
(deprecated)

string (int64 format)

फ़्रीक्वेंसी में योगदान देने वाले DV360 लाइन आइटम के आईडी.
cmCampaignIds[]
(deprecated)

string (int64 format)

फ़्रीक्वेंसी में योगदान करने वाले CM कैंपेन के आईडी.
googleAdsCampaignIds[]
(deprecated)

string (int64 format)

फ़्रीक्वेंसी में योगदान देने वाले Google Ads कैंपेन के आईडी.
eventMatchers[]

object (EventMatcher)

फ़्रीक्वेंसी को मैनेज करने वाले इवेंट. फ़्रीक्वेंसी के आधार पर उपयोगकर्ता सूचियां बनाते समय, इवेंट में शामिल होने के लिए इवेंट मैचर को प्राथमिकता दी जाती है. dv360LineitemIds, cmCampaignIds, और googleAdsCampaignIds का इस्तेमाल तब होता है, जब इवेंट मैचर खाली हों.
frequencyConstraint

object (FrequencyConstraint)

यह बताता है कि उपयोगकर्ता को सूची में कब जोड़ा गया.
slidingWindowDays

integer

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

इवेंट मैचर

सामान्य इवेंट, जो फ़्रीक्वेंसी में योगदान देता है.

जेएसओएन के काेड में दिखाना 
{
  "matchType": enum (MatchType),
  "value": string
}
फ़ील्ड
matchType

enum (MatchType)

फ़्रीक्वेंसी का टाइप, जिसे फ़्रीक्वेंसी की गिनती में शामिल किया जाएगा.
value

string

कंस्ट्रेंट की वैल्यू. उदाहरण के लिए, Google Ads कैंपेन आईडी = 1234 तय करने के लिए, मैच टाइप GOOGLE_ADS_CAMPAIGN_ID और वैल्यू '1234' होगा. फ़्रीक्वेंसी मैच में, ऐसे इवेंट शामिल किए जाएंगे जिनके लिए, मैचटाइप के हिसाब से यह वैल्यू सेट की गई है.

मैचटाइप

फ़्रीक्वेंसी की गिनती के लिए इस्तेमाल किए जा सकने वाले कंस्ट्रेंट के टाइप. आने वाले समय में, इस तरह के ईनम में और ज़्यादा टाइप जोड़े जा सकते हैं, ताकि कई तरह की पाबंदियों को लागू किया जा सके. मैच के टाइप में मौजूद फ़िल्टर की जानकारी देने के लिए, आप Descriptionमान्य फ़्रीक्वेंसी लिमिटिंग इवेंट मैच करने के अनुरोध में शामिल करें. इससे यह तय करने में मदद मिलती है कि नतीजों में जो इवेंट मैच हुए हैं वे सिर्फ़ आपके एपीआई के साथ काम करने वाले लोगों को दिखें. उदाहरण के लिए, फ़िल्टर को इस रूप में सेट करने पर और "eventMatcher.match_type= CM_CAMPAIGN_ID OR eventMatcher.match_type=GOOGLE_ADS_CAMPAIGN_ID" केवल उन दो प्रकार के अभियान-मैचर्स दिखाएगा.

Enums
MATCH_TYPE_UNSPECIFIED डिफ़ॉल्ट मान. यह वैल्यू इस्तेमाल नहीं की गई है.
CM_CAMPAIGN_ID कंस्ट्रेंट टाइप, Campaign Manager कैंपेन आईडी दिखाता है.
DV360_INSERTION_ORDER_ID DV360 के लिए इंसर्शन ऑर्डर आईडी दिखाने वाला कंस्ट्रेंट टाइप.
DV360_LINE_ITEM_ID DV360 के लिए लाइन आइटम आईडी दिखाने वाला कंस्ट्रेंट टाइप.
GOOGLE_ADS_CAMPAIGN_ID कंस्ट्रेंट का प्रकार, Google Ads कैंपेन आईडी दिखाता है.

फ़्रीक्वेंसी कंस्ट्रेंट

सीमा के लिए इवेंट की कम से कम संख्या तय करें.

जेएसओएन के काेड में दिखाना 
{
  "eventType": enum (EventType),
  "thresholdEventCount": string
}
फ़ील्ड
eventType

enum (EventType)

नहीं बदले जा सकते. इवेंट का टाइप, जिसे थ्रेशोल्डEventCount के तहत गिना जाएगा. फ़िलहाल, हम तुलना कंस्ट्रेंट के बारे में साफ़ तौर पर नहीं बताते हैं. हम यह मानते हैं कि सभी GREATER_OR_EQUAL हैं.
thresholdEventCount

string (int64 format)

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

इवेंट टाइप

फ़्रीक्वेंसी की गिनती करने के लिए इस्तेमाल किए जा सकने वाले इवेंट के टाइप.

Enums
EVENT_TYPE_UNSPECIFIED डिफ़ॉल्ट मान: इस्तेमाल नहीं किया जाना चाहिए.
IMPRESSIONS सभी इंप्रेशन को गिनें.

रीमार्केटिंग सूची की जानकारी

रीमार्केटिंग सूचियों के लिए मेटाडेटा.

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

string

नहीं बदले जा सकते. Ads Data Hub के उपयोगकर्ता सूची क्वेरी संसाधन, जो बताता है कि इस ऑडियंस में उपयोगकर्ता कैसे जोड़े जाते हैं. इसमें ग्राहक/[customerId]/userListQuery/[query_Resource_id] शामिल है
populatingUserListQueries[]

string

सिर्फ़ आउटपुट. Ads Data Hub के उपयोगकर्ता सूची में वे क्वेरी संसाधन मौजूद हैं जिनमें इस ऑडियंस की जानकारी अपने-आप भर गई है. इसका मकसद, उन उपयोगकर्ता सूचियों की मदद करना है जो 1:1 उपयोगकर्ता सूची:क्वेरी से जुड़ी पाबंदियों के लागू होने से पहले, एक से ज़्यादा क्वेरी से भरी हुई हैं. इसमें ग्राहक/[customerId]/userListQuery/[query_Resource_id] शामिल है

राज्य

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

Enums
STATE_UNSPECIFIED डिफ़ॉल्ट / सेट नहीं की गई वैल्यू.
STATE_ACTIVE उपयोगकर्ता सूची अब भी खुली है और चालू है.
STATE_DELETED उपयोगकर्ता सूची को 'मिटाई गई' के तौर पर मार्क किया गया है. अब इसका इस्तेमाल टारगेटिंग के लिए नहीं किया जाना चाहिए

तरीके

addEventMatchers

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

addRecipients

 Ads Data Hub से मैनेज की जाने वाली उपयोगकर्ता सूची में मौजूद लोगों के ईमेल पते जोड़ें.

create

 Ads Data Hub से मैनेज की जाने वाली उपयोगकर्ता सूची बनाता है.

delete

 अनुरोध किए गए Ads Data Hub से मैनेज की जाने वाली उपयोगकर्ता सूची मिटाएं.

generateFrequencyListMemberships

 UserList के लिए सदस्यताएं जनरेट करें.

get

 यह अनुरोध किए गए Ads Data Hub की मैनेज की गई उपयोगकर्ता सूची को वापस लाता है.

list

 उन उपयोगकर्ताओं की सूचियां बनाता है जिन्हें खास Ads Data Hub ग्राहक मैनेज करता है.

patch

 अनुरोध किए गए Ads Data Hub-मैनेज की गई उपयोगकर्ता सूची को अपडेट करता है.

removeRecipients

 Ads Data Hub से मैनेज की जाने वाली उपयोगकर्ता सूची में शामिल लोगों को हटाया जाता है.