SearchPartnerLinksRequest भेजकर, PartnerLink संसाधन वापस पाएं.
अनुरोध का parent फ़ील्ड ज़रूरी है. किसी खास खाते के संसाधन के नाम के लिए, parent को इस फ़ॉर्मैट में सेट करें:
accountTypes/{account_type}/accounts/{account}
अलग-अलग इस्तेमाल के मामलों में फ़्लेक्सिबिलिटी के लिए, SearchPartnerLinksResponse
में PartnerLink के सभी संसाधन शामिल होते हैं. इनमें अनुरोध में मौजूद parent इनमें से कोई एक होता है:
- वह खाता जिसकी पहचान
owner_accountफ़ील्ड से होती है - वह खाता जिसकी पहचान
partner_accountफ़ील्ड से होती है
अनुरोध के हेडर सेट करें, अगर पार्टनर लिंक, Google Ads के किसी पैरंट मैनेजर खाते या Display & Video 360 के किसी पैरंट पार्टनर
खाते का इस्तेमाल करके, parent खाते को ऐक्सेस किया जा रहा है.
नतीजों को फ़िल्टर करें ताकि जवाब को खास एट्रिब्यूट वाले संसाधनों तक सीमित किया जा सके.
Search तरीका, नतीजों के पेज दिखाता है. किसी अनुरोध के लिए सभी संसाधन वापस पाने के लिए, next_page_token देखें और नतीजों को पेजिनेट करें.
अनुरोध के हेडर सेट करना
Search तरीका, अनुरोध में मौजूद parent खाते के लिए, आपकी क्रेडेंशियल के ऐक्सेस पाथ को तय करने के लिए, login-account हेडर का इस्तेमाल करता है. PartnerLinkService
तरीकों के लिए, linked-account हेडर का इस्तेमाल नहीं किया जा सकता.
अलग-अलग ऐक्सेस के तरीकों के लिए हेडर सेट करने के बारे में जानकारी और निर्देश पाने के लिए, डेस्टिनेशन और हेडर देखें.
नतीजों को फ़िल्टर करना
पार्टनर के खास लिंक वापस पाने के लिए, अनुरोध के filter फ़ील्ड का इस्तेमाल करें. filter फ़ील्ड एक स्ट्रिंग है. इससे उन शर्तों का सेट तय होता है जिन्हें आपको लागू करना है. साथ ही, यह भी तय होता है कि एपीआई को AND या OR का इस्तेमाल करके, शर्तों को जोड़ना चाहिए या नहीं.
फ़िल्टर करने के विकल्पों और सिंटैक्स के बारे में ज़्यादा जानने के लिए,
AIP-160: फ़िल्टर करना लेख पढ़ें.
मालिक के खाते या पार्टनर खाते के account_id का इस्तेमाल करके, filter तय किया जा सकता है:
owning_account.account_id: मालिक के खाते काaccount_id.partner_account.account_id: पार्टनर खाते काaccount_id.
उदाहरण के लिए, यहां एक filter दिया गया है. इससे पार्टनर के वे सभी लिंक दिखते हैं जिनमें मालिक के खाते का आईडी OWNING_ACCOUNT_ID है:
owning_account.account_id = OWNING_ACCOUNT_ID
filter का एक और उदाहरण यहां दिया गया है. इससे पार्टनर के वे सभी लिंक दिखते हैं जिनमें मालिक के खाते का आईडी OWNING_ACCOUNT_ID है या पार्टनर खाते का आईडी PARTNER_ACCOUNT_ID है:
owning_account.account_id = OWNING_ACCOUNT_ID OR partner_account.account_id = PARTNER_ACCOUNT_ID
OR के बजाय AND का इस्तेमाल करने के लिए, उस filter में बदलाव करने पर, वापस लाए गए संसाधन, पार्टनर के उन लिंक तक सीमित हो जाते हैं जिनमें मालिक के खाते का आईडी OWNING_ACCOUNT_ID और पार्टनर खाते का आईडी PARTNER_ACCOUNT_ID दोनों होते हैं:
owning_account.account_id = OWNING_ACCOUNT_ID AND partner_account.account_id = PARTNER_ACCOUNT_ID
नतीजों को पेजिनेट करना
एक जवाब में दिखाए जाने वाले नतीजों की संख्या को कंट्रोल करने के लिए, page_size फ़ील्ड का इस्तेमाल करें. उदाहरण के लिए, अगर page_size को 10 पर सेट किया जाता है, तो एपीआई हर जवाब में ज़्यादा से ज़्यादा 10 नतीजे दिखाएगा. ऐसा हो सकता है कि एपीआई 10 से कम नतीजे दिखाए. ऐसा तब होता है, जब आपके अनुरोध से मेल खाने वाले नतीजे 10 से कम हों.
page_size की डिफ़ॉल्ट वैल्यू 50 है. इसकी ज़्यादा से ज़्यादा वैल्यू 1000 हो सकती है.
अगर एक जवाब में दिखाए जा सकने वाले नतीजों से ज़्यादा नतीजे हैं, तो जवाब में next_page_token शामिल होगा. नतीजों का अगला पेज या सेट वापस पाने के लिए, वही अनुरोध फिर से भेजें. हालांकि, इस बार page_token फ़ील्ड को इस वैल्यू पर सेट करें. अन्य सभी पैरामीटर, पिछले अनुरोध के जैसे ही होने चाहिए.
अगर जवाब में next_page_token फ़ील्ड शामिल नहीं है, तो इसका मतलब है कि अब कोई और नतीजा नहीं है.