मार्च 2022 में, हमने बिड मैनेजर एपीआई का वर्शन 2 रिलीज़ किया था. इस नए वर्शन की रिलीज़ को देखते हुए, हम जल्द ही v1.1 के बंद होने की तारीख का एलान करेंगे. हमारा सुझाव है कि आप जितनी जल्दी हो सके, v1.1 से v2 में अपना डेटा माइग्रेट करना शुरू कर दें.
अपना ऐप्लिकेशन माइग्रेट करें
v1.1 से v2 में माइग्रेट करने के लिए, आपको अपने एंडपॉइंट यूआरएल को v2 को कॉल करने के लिए अपडेट करना होगा. साथ ही, नुकसान पहुंचाने वाले बदलावों के लिए, खाते में अपने ऐप्लिकेशन को अपडेट करना होगा.
अपने एपीआई कॉल को v1.1 से v2 में अपडेट करें
v1.1 के बजाय v2 का इस्तेमाल करने के लिए, आपको नए v2 एंडपॉइंट का इस्तेमाल करने के लिए अपने अनुरोधों को अपडेट करना होगा.
समान विधियों की पहचान करना
v1.1 से v2 में इस्तेमाल करने से अपने एपीआई कॉल को अपडेट करने के लिए, पहले आपको v2 में समान v1.1 तरीकों की पहचान करनी होगी.
सभी सेवाओं और तरीकों के नीचे दिए गए नाम, v1.1 और v2 के बीच थोड़ा बदल गए हैं:
- v1.1 में सेवाओं
Queries
औरReports
कोqueries
औरqueries.reports
के नाम से जाना जाता है. - वर्शन 2 में तरीकों के नाम इस तरह बदले गए हैं:
नए एंडपॉइंट पर अपडेट करें
मिलते-जुलते तरीकों की पहचान करने के बाद, आपको अपने अनुरोधों को अपडेट करना होगा. उदाहरण
के लिए, queries.getquery
तरीके को v1.1 के साथ कॉल करने के लिए, आपको इस
यूआरएल का इस्तेमाल करना होगा:
https://www.googleapis.com/doubleclickbidmanager/v1.1/query/queryId
वर्शन 2 में, queries.get
नाम से मिलते-जुलते तरीके को कॉल करने के लिए, यूआरएल को इनमें से किसी एक तरीके से अपडेट करें:
GET https://doubleclickbidmanager.googleapis.com/v2/queries/queryId
अगर एपीआई को अनुरोध करने के लिए क्लाइंट लाइब्रेरी का इस्तेमाल किया जा रहा है, तो क्लाइंट लाइब्रेरी के सबसे हाल के वर्शन का इस्तेमाल करें और v2 का इस्तेमाल करने के लिए अपना कॉन्फ़िगरेशन अपडेट करें.
ज़रूरी बदलाव करें
हम v2 में कई नुकसान पहुंचा सकने वाले बदलाव पेश कर रहे हैं. नीचे दिए गए निर्देशों की समीक्षा करें और बिड मैनेजर एपीआई के मौजूदा इस्तेमाल से जुड़े ज़रूरी बदलाव करें.
queries
सेवा के लिए कॉल अपडेट करें
Query
संसाधन के नीचे दिए गए फ़ील्ड, मूल रूप से सामान्य नेस्ट किए गए ऑब्जेक्ट के ज़रिए दिखाए जाते हैं. इनमें अब इन ऑब्जेक्ट टाइप का इस्तेमाल किया गया है:Query
रिसॉर्स में मौजूद ये फ़ील्ड, मूल रूप से सामान्य सूची वाले ऑब्जेक्ट के ज़रिए दिखाए जाते हैं. अब ये फ़ील्ड, नीचे दिए गए नए ऑब्जेक्ट टाइप की सूची बन गए हैं:Query
रिसॉर्स के ये फ़ील्ड, मूल रूप से स्ट्रिंग से दिखाए जाते हैं. इन्हें v2 में एनम टाइप के तौर पर दिखाया जाता है. इनमें ये बदलाव शामिल होते हैं:metadata.dataRange
के जैसा v2 वर्शन अबRange
enum का इस्तेमाल करता है. इस एनम में बदलने पर, वैल्यूPREVIOUS_HALF_MONTH
को हटा दिया गया है और वैल्यूTYPE_NOT_SUPPORTED
को बदलकरRANGE_UNSPECIFIED
कर दिया गया है.metadata.format
अबFormat
Enum का इस्तेमाल करता है. इस ईनम में बदलने के लिए,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 का इस्तेमाल करता है. इस Enum में बदलने पर,PATH_MATCH_POSITION_UNSPECIFIED
वैल्यू जोड़ी गई.schedule.frequency
अबFrequency
Enum का इस्तेमाल करता है. इस Enum में बदलने के दौरान,FREQUENCY_UNSPECIFIED
वैल्यू जोड़ी गई है.params.type
अबReportType
Enum का इस्तेमाल करता है. इस ईनम में बदलने के दौरान, ये बदलाव किए गए हैं:- ये वैल्यू अब काम नहीं करतीं:
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
से बदल दिया गया है. तारीख के नए फ़ील्ड, Unix Epoch के बाद के मिलीसेकंड के बजाय,Date
ऑब्जेक्ट का इस्तेमाल करते हैं. ये बदले गए फ़ील्डQueryMetadata
ऑब्जेक्ट केdataRange
फ़ील्ड को असाइन किए गएDataRange
ऑब्जेक्ट में ले जाए गए हैं. - फ़ील्ड
schedule.startTimeMs
औरschedule.endTimeMs
कोQuerySchedule
ऑब्जेक्ट मेंstartDate
औरendDate
के फ़ील्ड से बदल दिया गया है. तारीख के नए फ़ील्ड, Unix Epoch के बाद के मिलीसेकंड के बजाय,Date
ऑब्जेक्ट का इस्तेमाल करते हैं. - फ़ील्ड
metadata.running
,metadata.reportCount
,metadata.googleCloudStoragePathForLatestReport
,metadata.googleDrivePathForLatestReport
, औरmetadata.latestReportRunTimeMs
हटा दिए गए हैं. किसी क्वेरी की हाल ही में जनरेट की गई रिपोर्ट से संबंधित जानकारीqueries.reports.list
तरीके का इस्तेमाल करकेorderBy
क्वेरी पैरामीटर का इस्तेमाल करके फिर से हासिल की जानी चाहिए, जो सबसे पहले अनुरोध की गई - फ़ील्ड
kind
,timezoneCode
,metadata.locale
,params.includeInviteData
, औरschedule.nextRunMinuteOfDay
हटा दिए गए हैं. queries.create
प्रॉपर्टी बनाने के बाद, अब अपने-आप क्वेरी नहीं चलाता औरasynchronous
क्वेरी पैरामीटर को हटा दिया जाता है. नई क्वेरी की रिपोर्ट जनरेट करने के लिए,queries.create
के बादqueries.run
को कॉल करें.queries.run
तरीके को इन तरीकों से अपडेट किया गया है:asynchronous
क्वेरी पैरामीटर कोsynchronous
क्वेरी पैरामीटर से बदल दिया गया है. नया क्वेरी पैरामीटर इनवर्स लॉजिक के साथ काम करता है. अगर इसके बारे में नहीं बताया गया है, तो इसे 'गलत' माना जाता है. इसे देखते हुए,queries.run
सिंक्रोनस के बजाय, डिफ़ॉल्ट रूप से एसिंक्रोनस रूप से रिपोर्ट जनरेट करता है. यह वर्शन 1.1 में डिफ़ॉल्ट तौर पर उपलब्ध है.timezoneCode
फ़ील्ड को हटाने औरdataRange
,reportDataStartTimeMs
,reportDataEndTimeMs
फ़ील्ड कोdataRange
फ़ील्ड को असाइन किए गएDataRange
ऑब्जेक्ट से बदलने के लिए, अनुरोध के मुख्य हिस्से को अपडेट किया गया है.- यह तरीका, रिस्पॉन्स के खाली हिस्से के बजाय,
Report
ऑब्जेक्ट दिखाता है.
queries.list
जवाब के मुख्य भाग में मौजूदkind
फ़ील्ड को हटा दिया गया है.
reports
सेवा के लिए कॉल अपडेट करें
Report
संसाधन के नीचे दिए गए फ़ील्ड, मूल रूप से सामान्य नेस्ट किए गए ऑब्जेक्ट के ज़रिए दिखाए जाते हैं. इनमें अब इस तरह के ऑब्जेक्ट का इस्तेमाल किया गया है:Report
संसाधन में मौजूद ये फ़ील्ड मूल रूप से सामान्य सूची ऑब्जेक्ट के ज़रिए दिखाए जाते हैं. अब ये फ़ील्ड, नीचे दिए गए नए ऑब्जेक्ट टाइप की सूची बन गए हैं:Report
रिसॉर्स में, जिन फ़ील्ड को मूल रूप से स्ट्रिंग के ज़रिए दिखाया जाता है उनमें बदलाव हुए हैं. इसलिए, v2 में उनके मिलते-जुलते फ़ील्ड, नए एनम टाइप के तौर पर दिखाए जाएंगे. साथ ही, इनमें स्वीकार की जाने वाली वैल्यू में बदलाव शामिल होंगे:metadata.status.format
अबFormat
Enum का इस्तेमाल करता है. इस ईनम में बदलने के लिए,EXCEL_CSV
वैल्यू को हटा दिया गया है औरFORMAT_UNSPECIFIED
को जोड़ दिया गया है.metadata.status.state
अबState
Enum का इस्तेमाल करता है. इस Enum में बदलने के दौरान,QUEUED
औरSTATE_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 का इस्तेमाल करता है. इस Enum में बदलने पर,PATH_MATCH_POSITION_UNSPECIFIED
वैल्यू जोड़ी गई.params.type
अबReportType
Enum का इस्तेमाल करता है. इस सूची को बदलने के लिए, कई बदलाव किए गए हैं. इनकी जानकारी पिछले सेक्शन में, क्वेरी सेवा कॉल को अपडेट करने से जुड़े ब्यौरे में दी गई है.
- फ़ील्ड
metadata.reportDataStartTimeMs
औरmetadata.reportDataEndTimeMs
कोReportMetadata
ऑब्जेक्ट मेंreportDataEndDate
फ़ील्डreportDataStartDate
औरreportDataEndDate
से बदल दिया गया है. नए फ़ील्ड, Unix Epoch के बाद के मिलीसेकंड के बजायDate
ऑब्जेक्ट का इस्तेमाल करते हैं. ReportStatus
ऑब्जेक्ट केmetadata.status.finishTimeMs
फ़ील्ड कोfinishTime
फ़ील्ड से बदल दिया गया है. समय का यह नया फ़ील्ड, Unix Epoch के लिए मिलीसेकंड के बजाय, RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में टाइमस्टैंप के तौर पर दिखता है.metadata.status.failure
औरparams.includeInviteData
फ़ील्ड हटा दिए गए हैं.reports.list
रिस्पॉन्स के मुख्य हिस्से में मौजूदkind
फ़ील्ड को हटा दिया गया है.
गड़बड़ी मैनेज करने के लॉजिक को अपडेट करें
एपीआई के गड़बड़ी वाले मैसेज, v2 में अपडेट कर दिए गए हैं. ये नए गड़बड़ी के मैसेज ज़्यादा खास होते हैं और कुछ मामलों में, एपीआई अनुरोध में उन वैल्यू की जानकारी देते हैं जिनकी वजह से गड़बड़ी होती है. अगर गड़बड़ी को मैनेज करने वाला आपका मौजूदा लॉजिक, गड़बड़ी के किसी खास मैसेज के टेक्स्ट पर निर्भर करता है, तो v2 पर माइग्रेट करने से पहले, गड़बड़ी को मैनेज करने से जुड़ी अपनी मौजूदा प्रोसेस को सामान्य बनाएं.