Method: advertisers.reachForecast.retrievePlannableUserLists

पूर्वानुमान के लिए उपलब्ध, पहले और तीसरे पक्ष की उपयोगकर्ता सूचियां वापस लाता है.

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

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableUserLists

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

पाथ पैरामीटर

पैरामीटर
advertiserId

string (int64 format)

ज़रूरी है. यह विज्ञापन देने वाले का आईडी है, जिसके लिए प्लैन की जा सकने वाली उपयोगकर्ता सूचियां वापस लानी हैं.

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

पैरामीटर
pageSize

integer

ज़रूरी नहीं. अनुरोध किया गया पेज साइज़. यह 1 से 5000 के बीच होना चाहिए. अगर कोई वैल्यू नहीं दी जाती है, तो डिफ़ॉल्ट रूप से 5000 वैल्यू सेट हो जाएगी.
pageToken

string

ज़रूरी नहीं. यह एक टोकन है, जिससे यह पता चलता है कि सर्वर को नतीजों का कौनसा पेज दिखाना चाहिए. आम तौर पर, यह reachForecast.retrievePlannableUserLists तरीके को पिछली बार कॉल करने पर मिले nextPageToken की वैल्यू होती है. अगर कोई वैल्यू नहीं दी जाती है, तो नतीजों का पहला पेज दिखाया जाएगा.
filter

string

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

इस्तेमाल किया जा सकने वाला सिंटैक्स:

  • फ़िल्टर एक्सप्रेशन, एक या उससे ज़्यादा पाबंदियों से बने होते हैं.
  • पाबंदियों को AND या OR लॉजिकल ऑपरेटर के साथ मिलाकर लिखा जा सकता है.
  • किसी पाबंदी का फ़ॉर्मैट {field} {operator} {value} होता है.
  • displayName फ़ील्ड के लिए, HAS (:) ऑपरेटर का इस्तेमाल करना ज़रूरी है.
  • अन्य सभी फ़ील्ड के लिए, EQUALS (=) ऑपरेटर का इस्तेमाल करना ज़रूरी है.

इस्तेमाल किए जा सकने वाले फ़ील्ड:

  • plannableStatus
  • displayName
  • userListType
  • name

उदाहरण:

  • प्लैन की जा सकने वाली सभी उपयोगकर्ता सूचियां: plannableStatus="PLANNABLE"
  • प्लैन की जा सकने वाली वे उपयोगकर्ता सूचियां जिनके डिसप्ले नेम में "Shopping" शामिल है: plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • पहले पक्ष की उपयोगकर्ता सूचियां: userListType="FIRST_PARTY"

इस फ़ील्ड की लंबाई 500 वर्णों से ज़्यादा नहीं होनी चाहिए.

ज़्यादा जानकारी के लिए, फ़िल्टर करने के लिए LIST अनुरोधों से जुड़ी हमारी गाइड देखें.

अनुरोध का मुख्य हिस्सा

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

जवाब का मुख्य हिस्सा

reachForecast.retrievePlannableUserLists का जवाब.

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

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

object (PlannableUserList)

सिर्फ़ आउटपुट के लिए. प्लैन की जा सकने वाली उपयोगकर्ता सूचियों की सूची.
nextPageToken

string

सिर्फ़ आउटपुट के लिए. नतीजों का अगला पेज वापस पाने के लिए टोकन.

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

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

  • https://www.googleapis.com/auth/display-video

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

PlannableUserList

यह प्लैन की जा सकने वाली उपयोगकर्ता सूची है, जिसका इस्तेमाल रीच का पूर्वानुमान लगाने के लिए किया जाता है.

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
फ़ील्ड
displayName

string

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

enum (UserListType)

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

string

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

फ़ॉर्मैट: advertisers/{advertiserId}/userLists/{user_list_id}
plannableStatus

enum (PlannableStatus)

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

UserListType

उपयोगकर्ता सूचियों के टाइप.

Enums
USER_LIST_TYPE_UNSPECIFIED उपयोगकर्ता सूची के टाइप के बारे में कोई जानकारी नहीं है.
FIRST_PARTY पहले पक्ष की उपयोगकर्ता सूची.
THIRD_PARTY तीसरे पक्ष की उपयोगकर्ता सूची.

PlannableStatus

यह स्थिति बताती है कि किसी सूची को प्लैन किया जा सकता है या नहीं.

Enums
PLANNABLE_STATUS_UNSPECIFIED प्लैनिंग की स्थिति के बारे में कोई जानकारी नहीं है.
PLANNABLE उपयोगकर्ता सूची को प्लैन किया जा सकता है.
UNPLANNABLE उपयोगकर्ता सूची को प्लैन नहीं किया जा सकता.