बिड मैनेजर एपीआई के 1.1 वर्शन से वर्शन 2 पर माइग्रेट करना

मार्च 2022 में, हमने Bid Manager API का वर्शन 2 रिलीज़ किया था. यह देखते हुए हमने v1.1 वर्शन को जल्द ही बंद करने का एलान किया है. बुध का सुझाव है कि आप जल्द से जल्द v1.1 से v2 पर माइग्रेशन शुरू करें.

अपना ऐप्लिकेशन माइग्रेट करें

v1.1 से v2 पर माइग्रेट करने के लिए, अपने एंडपॉइंट यूआरएल को v2 को कॉल करना ज़रूरी है और बदलावों को नुकसान पहुंचाने के लिए, आपके ऐप्लिकेशन को खाते में अपडेट करना.

अपने एपीआई कॉल को v1.1 से v2 में अपडेट करना

अगर आपको v1.1 के बजाय v2 का इस्तेमाल करना है, तो आपको नए वर्शन 2 के इस्तेमाल के अपने अनुरोधों को अपडेट करना होगा एंडपॉइंट के बारे में भी बताएंगे.

समतुल्य विधियों की पहचान करना

v1.1 का इस्तेमाल करके v2 में अपने एपीआई कॉल अपडेट करने के लिए, आपको सबसे पहले v2 में v1.1 वाले मिलते-जुलते तरीके शामिल करने होंगे.

नीचे सभी सेवाओं और विधियों के नाम थोड़े बदल गए हैं v1.1 और v2:

नए एंडपॉइंट पर अपडेट करें

मिलते-जुलते तरीकों की पहचान करने के बाद, आपको अपने अनुरोधों को अपडेट करना होगा. इसके लिए उदाहरण के लिए, v1.1 के साथ queries.getquery तरीके को कॉल करने के लिए, नीचे दिया गया यूआरएल:

https://www.googleapis.com/doubleclickbidmanager/v1.1/query/queryId

v2 में मिलते-जुलते तरीके, जिसे queries.get कहा जाता है, को कॉल करने के लिए अपडेट करें इसके लिए यूआरएल:

GET https://doubleclickbidmanager.googleapis.com/v2/queries/queryId

अगर एपीआई को अनुरोध करने के लिए, क्लाइंट लाइब्रेरी का इस्तेमाल किया जा रहा है, तो और अपने कॉन्फ़िगरेशन को v2 का इस्तेमाल करने के लिए अपडेट करें.

ज़रूरी बदलाव करें

हम वर्शन 2 में नुकसान पहुंचाने वाले कई बदलाव पेश कर रहे हैं. इनकी समीक्षा करें साथ ही, आपको इसमें ज़रूरी बदलाव करने होंगे, बिड मैनेजर एपीआई.

queries सेवा पर कॉल अपडेट करें

  • Query संसाधन में दिए गए ये फ़ील्ड मूल रूप से सामान्य हैं नीचे दिए गए ऑब्जेक्ट टाइप का इस्तेमाल करने के लिए, नेस्ट किए गए ऑब्जेक्ट में बदलाव किया गया है:
    v1.1 फ़ील्डइक्विवैलेंट v2 ऑब्जेक्ट टाइप
    metadata QueryMetadata
    params Parameters
    params.options Options
    params.options.pathQueryOptions PathQueryOptions
    params.options.pathQueryOptions.channelGrouping ChannelGrouping
    params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter PathQueryOptionsFilter
    params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter PathQueryOptionsFilter
    schedule QuerySchedule
  • Query संसाधन में दिए गए ये फ़ील्ड मूल रूप से सामान्य हैं सूची ऑब्जेक्ट को नीचे दिए गए नए ऑब्जेक्ट टाइप की सूची में बदल दिया गया है:
    v1.1 सूची फ़ील्डv2 ऑब्जेक्ट टाइप
    params.filters[] FilterPair
    params.options.pathQueryOptions.channelGrouping.rules[] Rule
    params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[] DisjunctiveMatchStatement
    params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[] EventFilter
    params.options.pathQueryOptions.pathFilters[] PathFilter
    params.options.pathQueryOptions.pathFilters[].eventFilters[] EventFilter
  • Query संसाधन में दिए गए ये फ़ील्ड, मूल रूप से इसे दिखाते हैं स्ट्रिंग को वर्शन 2 में ईनम टाइप से दिखाया जाता है. इसमें ये शामिल हैं बदलाव:
    • metadata.dataRange का वर्शन 2, अब Range का इस्तेमाल करता है Enum. इस ईनम को बदलने के लिए, PREVIOUS_HALF_MONTH वैल्यू निकाला गया और मान TYPE_NOT_SUPPORTED को बदलकर यह किया गया RANGE_UNSPECIFIED.
    • metadata.format अब Format ईनम का इस्तेमाल करता है. रूपांतरण में है इस ईनम से, EXCEL_CSV मान हटा दिया गया है और FORMAT_UNSPECIFIED को जोड़ दिया गया है.
    • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match और params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match अब Match enum का इस्तेमाल करें.
    • params.options.pathQueryOptions.pathFilters[].pathMatchPosition अब इस्तेमाल करता है PathMatchPosition एनम. इसमें बदलने में इस enum में, PATH_MATCH_POSITION_UNSPECIFIED मान जोड़ा गया है.
    • schedule.frequency अब Frequency ईनम का इस्तेमाल करता है. तय सीमा में इस ईनम में बदलने पर, FREQUENCY_UNSPECIFIED वैल्यू जोड़ी गई है.
    • params.type अब ReportType ईनम का इस्तेमाल करता है. तय सीमा में इस ईनम में बदलने के लिए, ये बदलाव किए गए हैं:
    • ये वैल्यू अब काम नहीं करतीं:
      • TYPE_ACTIVE_GRP
      • TYPE_AUDIENCE_PERFORMANCE
      • TYPE_CLIENT_SAFE
      • TYPE_COMSCORE_VCE
      • TYPE_CROSS_FEE
      • TYPE_CROSS_PARTNER
      • TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER
      • TYPE_ESTIMATED_CONVERSION
      • TYPE_FEE
      • TYPE_KEYWORD
      • TYPE_LINEAR_TV_SEARCH_LIFT
      • TYPE_NIELSEN_AUDIENCE_PROFILE
      • TYPE_NIELSEN_DAILY_REACH_BUILD
      • TYPE_NIELSEN_ONLINE_GLOBAL_MARKET
      • TYPE_PAGE_CATEGORY
      • TYPE_PETRA_NIELSEN_DAILY_REACH_BUILD
      • TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET
      • TYPE_PIXEL_LOAD
      • TYPE_THIRD_PARTY_DATA_PROVIDER
      • TYPE_TRUEVIEW_IAR
      • TYPE_VERIFICATION
      • TYPE_YOUTUBE_VERTICAL
    • बाकी सभी वैल्यू को अपडेट कर दिया गया है, ताकि वे बेहतर तरीके से दिखें यूज़र इंटरफ़ेस (यूआई) में एक जैसी वैल्यू:
      v1.1 की वैल्यूReportType के बराबर वैल्यू
      TYPE_NOT_SUPPORTED REPORT_TYPE_UNSPECIFIED
      TYPE_GENERAL STANDARD
      TYPE_INVENTORY_AVAILABILITY INVENTORY_AVAILABILITY
      TYPE_AUDIENCE_COMPOSITION AUDIENCE_COMPOSITION
      TYPE_ORDER_ID FLOODLIGHT
      TYPE_TRUEVIEW YOUTUBE
      TYPE_NIELSEN_SITE GRP
      TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE YOUTUBE_PROGRAMMATIC_GUARANTEED
      TYPE_REACH_AND_FREQUENCY REACH
      TYPE_REACH_AUDIENCE UNIQUE_REACH_AUDIENCE
      TYPE_PATH FULL_PATH
      TYPE_PATH_ATTRIBUTION PATH_ATTRIBUTION
  • फ़ील्ड metadata.dataRange, reportDataStartTimeMs, और reportDataEndTimeMs को फ़ील्ड से बदल दिया गया है range, customStartDate, और customEndDate. तारीख के नए फ़ील्ड Date का इस्तेमाल करते हैं Unix Epoch के बाद के, मिलीसेकंड के बजाय ऑब्जेक्ट. ये रीप्लेसमेंट फ़ील्ड DataRange ऑब्जेक्ट में ले जाया गया है. यह ऑब्जेक्ट dataRange फ़ील्ड में QueryMetadata ऑब्जेक्ट.
  • फ़ील्ड schedule.startTimeMs और schedule.endTimeMs को फ़ील्ड से बदल दिया गया है startDate और endDate में QuerySchedule ऑब्जेक्ट. तारीख के नए फ़ील्ड Date का इस्तेमाल करते हैं Unix Epoch के बाद के, मिलीसेकंड के बजाय ऑब्जेक्ट.
  • फ़ील्ड metadata.running, metadata.reportCount metadata.googleCloudStoragePathForLatestReport, metadata.googleDrivePathForLatestReport और metadata.latestReportRunTimeMs को हटा दिया गया है. किसी क्वेरी की सबसे हाल ही में जनरेट की गई रिपोर्ट से जुड़ी जानकारी में इसके बजाय, इसे queries.reports.list तरीके का इस्तेमाल करके, फिर से फ़ेच किया जाएगा “key.reportId desc” के ज़रिए orderBy क्वेरी पैरामीटर इस बात की गारंटी देती है कि अनुरोध में सबसे हाल की रिपोर्ट सबसे पहले शामिल की गई हो.
  • फ़ील्ड kind, timezoneCode, metadata.locale, params.includeInviteData और schedule.nextRunMinuteOfDay को हटा दिया गया है.
  • स्पेस बनाने के बाद, queries.create अब अपने-आप क्वेरी नहीं चलाता है और asynchronous क्वेरी पैरामीटर को हटा दिया गया है. कॉल करें रिपोर्ट जनरेट करने के लिए, queries.create के बाद queries.run लगेंगे नई क्वेरी.
  • queries.run तरीके को इन तरीकों से अपडेट किया गया है:
    • asynchronous क्वेरी पैरामीटर को synchronous क्वेरी पैरामीटर. नया क्वेरी पैरामीटर इन्वर्स लॉजिक के साथ काम करता है और तय न किए जाने पर इसे गलत माना जाता है. दिया गया इसका मतलब है कि queries.run डिफ़ॉल्ट रूप से एसिंक्रोनस रूप से v2. यह डिफ़ॉल्ट रूप से v1.1 वर्शन में होता है.
    • अनुरोध के मुख्य हिस्से को अपडेट करके, timezoneCode फ़ील्ड में बदलाव करें और बदलें dataRange, reportDataStartTimeMs, reportDataEndTimeMs फ़ील्ड DataRange ऑब्जेक्ट, dataRange फ़ील्ड.
    • यह तरीका, किसी ऑब्जेक्ट के बजाय Report ऑब्जेक्ट दिखाता है जवाब का मुख्य हिस्सा खाली है.
  • kind फ़ील्ड, queries.list रिस्पॉन्स के मुख्य हिस्से में को निकाल दिया गया है.

reports सेवा पर कॉल अपडेट करें

गड़बड़ी ठीक करने वाला लॉजिक अपडेट करें

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