इस संसाधन के लिए तरीका जानने के लिए, इस पेज के आखिर में देखें.
संसाधन के बारे में जानकारी
एक DoubleClick खोज रिपोर्ट. इस ऑब्जेक्ट में रिपोर्ट अनुरोध, मुद्रा कोड जैसा कुछ रिपोर्ट मेटाडेटा, और जनरेट की गई रिपोर्ट पंक्तियां या रिपोर्ट फ़ाइलें शामिल होती हैं.
{ "kind": "doubleclicksearch#report", "id": string, "isReportReady": boolean, "request": { "reportScope": { "agencyId": long, "advertiserId": long, "engineAccountId": long, "campaignId": long, "adGroupId": long, "keywordId": long, "adId": long }, "reportType": string, "columns": [ { "columnName": string, "savedColumnName": string, "customDimensionName": string, "customMetricName": string, "headerText": string, "startDate": string, "endDate": string, "groupByColumn": boolean, "platformSource": string, "productReportPerspective": string } ], "timeRange": { "startDate": string, "endDate": string, "changedMetricsSinceTimestamp": datetime, "changedAttributesSinceTimestamp": datetime }, "filters": [ { "column": { "columnName": string, "savedColumnName": string, "customDimensionName": string, "customMetricName": string, "headerText": string, "startDate": string, "endDate": string, "groupByColumn": boolean, "platformSource": string, "productReportPerspective": string }, "operator": string, "values": [ (value) ] } ], "orderBy": [ { "column": { "columnName": string, "savedColumnName": string, "customDimensionName": string, "customMetricName": string, "headerText": string, "startDate": string, "endDate": string, "groupByColumn": boolean, "platformSource": string, "productReportPerspective": string }, "sortOrder": string } ], "includeDeletedEntities": boolean, "includeRemovedEntities": boolean, "verifySingleTimeZone": boolean, "downloadFormat": string, "statisticsCurrency": string, "startRow": integer, "rowCount": integer, "maxRowsPerFile": integer }, "statisticsCurrencyCode": string, "statisticsTimeZone": string, "rowCount": integer, "files": [ { "url": string, "byteCount": long } ], "rows": [ { (key): (value) } ] }
प्रॉपर्टी का नाम | वैल्यू | ब्यौरा | नोट |
---|---|---|---|
files[] |
list |
सिर्फ़ एसिंक्रोनस रिपोर्ट. रिपोर्ट जनरेट होने के बाद, जनरेट की गई रिपोर्ट फ़ाइलों की सूची शामिल की जाती है. | |
files[].byteCount |
long |
इस रिपोर्ट फ़ाइल का साइज़ बाइट में है. | |
files[].url |
string |
रिपोर्ट फ़ाइल डाउनलोड करने के लिए इस यूआरएल का इस्तेमाल करें. | |
id |
string |
सिर्फ़ एसिंक्रोनस रिपोर्ट. रिपोर्ट का आईडी. | |
isReportReady |
boolean |
सिर्फ़ एसिंक्रोनस रिपोर्ट. अगर रिपोर्ट पूरी हो गई है और रिपोर्ट डाउनलोड होने के लिए तैयार हैं, तभी सही. | |
kind |
string |
इसकी पहचान, रिपोर्ट रिसॉर्स के तौर पर करती है. वैल्यू: तय की गई स्ट्रिंग doubleclicksearch#report . |
|
request |
nested object |
अनुरोध बनाने वाला अनुरोध. मूल अनुरोध में नहीं दिए गए वैकल्पिक फ़ील्ड डिफ़ॉल्ट मानों से भरे जाते हैं. | |
request.columns[] |
list |
रिपोर्ट में शामिल किए जाने वाले कॉलम. इसमें DoubleClick खोज स्तंभ और सहेजे गए स्तंभ, दोनों शामिल हैं. DoubleClick खोज कॉलम के लिए, सिर्फ़ columnName पैरामीटर ज़रूरी है. सेव किए गए कॉलम के लिए, सिर्फ़ savedColumnName पैरामीटर ज़रूरी है. columnName और savedColumnName को एक ही क्रम में सेट नहीं किया जा सकता. हर अनुरोध में ज़्यादा से ज़्यादा 300 कॉलम हो सकते हैं. |
|
request.columns[].columnName |
string |
रिपोर्ट में शामिल करने के लिए, DoubleClick खोज कॉलम का नाम. | |
request.columns[].customDimensionName |
string |
रिपोर्ट को कस्टम डाइमेंशन के हिसाब से सेगमेंट करता है. रिपोर्ट का दायरा, विज्ञापन देने वाले या उससे कम पर होना चाहिए. साथ ही, कस्टम डाइमेंशन पहले से ही DoubleClick Search में सेट अप होना चाहिए. DoubleClick खोज में दिखाई देने वाला कस्टम आयाम नाम, केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होता है. अगर इसका इस्तेमाल कन्वर्ज़न रिपोर्ट में किया जाता है, तो दिए गए कन्वर्ज़न के लिए तय किए गए कस्टम डाइमेंशन की वैल्यू दिखती है. ऐसा तब होता है, जब यह सेट हो. यह कॉलम, कन्वर्ज़न रिपोर्ट को सेगमेंट नहीं करता. |
|
request.columns[].customMetricName |
string |
रिपोर्ट में शामिल करने के लिए कस्टम मेट्रिक का नाम. रिपोर्ट, विज्ञापन देने वाले या उससे कम के दायरे में होनी चाहिए. साथ ही, कस्टम मेट्रिक पहले से ही DoubleClick Search में सेट अप होना चाहिए. DoubleClick खोज में दिखाई देने वाला कस्टम मेट्रिक नाम, केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होता है. | |
request.columns[].endDate |
string |
YYYY-MM-DD फ़ॉर्मैट में दिन शामिल है. अगर इसे दिया जाता है, तो इससे सिर्फ़ इस कॉलम की रिपोर्ट की कुल समयसीमा बदल जाती है. startDate के साथ दी जानी चाहिए. |
|
request.columns[].groupByColumn |
boolean |
सिर्फ़ सिंक्रोनस रिपोर्ट. true को इस कॉलम के हिसाब से ग्रुप करने के लिए सेट करें. false पर डिफ़ॉल्ट. |
|
request.columns[].headerText |
string |
रिपोर्ट आउटपुट में इस कॉलम की पहचान करने के लिए इस्तेमाल किया जाने वाला टेक्स्ट; तय न होने पर डिफ़ॉल्ट रूप से columnName या savedColumnName हो जाता है. इसका इस्तेमाल DoubleClick Search कॉलम और सेव किए गए कॉलम के बीच टकराव से बचने के लिए किया जा सकता है. |
|
request.columns[].platformSource |
string |
कस्टम डाइमेंशन के लिए डेटा देने के लिए इस्तेमाल किया जाने वाला प्लैटफ़ॉर्म. स्वीकार की जाने वाली वैल्यू "बाढ़ की रोशनी" है. | |
request.columns[].productReportPerspective |
string |
सिर्फ़ खास तरह की प्रॉडक्ट गतिविधि के लिए मेट्रिक दिखाता है. स्वीकार की जाने वाली वैल्यू ये हैं:
|
|
request.columns[].savedColumnName |
string |
सेव किए गए कॉलम का नाम, जिसे रिपोर्ट में शामिल करना है. रिपोर्ट का दायरा विज्ञापनदाता या उससे कम पर होना चाहिए और यह सहेजा गया स्तंभ पहले से DoubleClick खोज यूज़र इंटरफ़ेस (यूआई) में बनाया जाना चाहिए. | |
request.columns[].startDate |
string |
YYYY-MM-DD फ़ॉर्मैट में शामिल करने की तारीख. अगर इसे दिया जाता है, तो इससे सिर्फ़ इस कॉलम की रिपोर्ट की कुल समयसीमा बदल जाती है. endDate के साथ दी जानी चाहिए. |
|
request.downloadFormat |
string |
वह फ़ॉर्मैट जिसमें रिपोर्ट वापस करनी है. फ़िलहाल, csv या tsv के साथ काम करता है. |
|
request.filters[] |
list |
रिपोर्ट पर लागू किए जाने वाले फ़िल्टर की सूची. हर अनुरोध के लिए, ज़्यादा से ज़्यादा 300 फ़िल्टर इस्तेमाल किए जा सकते हैं. |
|
request.filters[].column |
nested object |
फ़िल्टर लगाने के लिए कॉलम. यह DoubleClick खोज कॉलम या सेव किया गया कॉलम हो सकता है. | |
request.filters[].column.columnName |
string |
रिपोर्ट में शामिल करने के लिए, DoubleClick खोज कॉलम का नाम. | |
request.filters[].column.customDimensionName |
string |
रिपोर्ट को कस्टम डाइमेंशन के हिसाब से सेगमेंट करता है. रिपोर्ट का दायरा, विज्ञापन देने वाले या उससे कम पर होना चाहिए. साथ ही, कस्टम डाइमेंशन पहले से ही DoubleClick Search में सेट अप होना चाहिए. DoubleClick खोज में दिखाई देने वाला कस्टम आयाम नाम, केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होता है. अगर इसका इस्तेमाल कन्वर्ज़न रिपोर्ट में किया जाता है, तो दिए गए कन्वर्ज़न के लिए तय किए गए कस्टम डाइमेंशन की वैल्यू दिखती है. ऐसा तब होता है, जब यह सेट हो. यह कॉलम, कन्वर्ज़न रिपोर्ट को सेगमेंट नहीं करता. |
|
request.filters[].column.customMetricName |
string |
रिपोर्ट में शामिल करने के लिए कस्टम मेट्रिक का नाम. रिपोर्ट, विज्ञापन देने वाले या उससे कम के दायरे में होनी चाहिए. साथ ही, कस्टम मेट्रिक पहले से ही DoubleClick Search में सेट अप होना चाहिए. DoubleClick खोज में दिखाई देने वाला कस्टम मेट्रिक नाम, केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होता है. | |
request.filters[].column.endDate |
string |
YYYY-MM-DD फ़ॉर्मैट में दिन शामिल है. अगर इसे दिया जाता है, तो इससे सिर्फ़ इस कॉलम की रिपोर्ट की कुल समयसीमा बदल जाती है. startDate के साथ दी जानी चाहिए. |
|
request.filters[].column.groupByColumn |
boolean |
सिर्फ़ सिंक्रोनस रिपोर्ट. true को इस कॉलम के हिसाब से ग्रुप करने के लिए सेट करें. false पर डिफ़ॉल्ट. |
|
request.filters[].column.headerText |
string |
रिपोर्ट आउटपुट में इस कॉलम की पहचान करने के लिए इस्तेमाल किया जाने वाला टेक्स्ट; तय न होने पर डिफ़ॉल्ट रूप से columnName या savedColumnName हो जाता है. इसका इस्तेमाल DoubleClick Search कॉलम और सेव किए गए कॉलम के बीच टकराव से बचने के लिए किया जा सकता है. |
|
request.filters[].column.platformSource |
string |
कस्टम डाइमेंशन के लिए डेटा देने के लिए इस्तेमाल किया जाने वाला प्लैटफ़ॉर्म. स्वीकार की जाने वाली वैल्यू "बाढ़ की रोशनी" है. | |
request.filters[].column.productReportPerspective |
string |
सिर्फ़ खास तरह की प्रॉडक्ट गतिविधि के लिए मेट्रिक दिखाता है. स्वीकार की जाने वाली वैल्यू ये हैं:
|
|
request.filters[].column.savedColumnName |
string |
सेव किए गए कॉलम का नाम, जिसे रिपोर्ट में शामिल करना है. रिपोर्ट का दायरा विज्ञापनदाता या उससे कम पर होना चाहिए और यह सहेजा गया स्तंभ पहले से DoubleClick खोज यूज़र इंटरफ़ेस (यूआई) में बनाया जाना चाहिए. | |
request.filters[].column.startDate |
string |
YYYY-MM-DD फ़ॉर्मैट में शामिल करने की तारीख. अगर इसे दिया जाता है, तो इससे सिर्फ़ इस कॉलम की रिपोर्ट की कुल समयसीमा बदल जाती है. endDate के साथ दी जानी चाहिए. |
|
request.filters[].operator |
string |
फ़िल्टर में इस्तेमाल करने के लिए ऑपरेटर. उपलब्ध ऑपरेटर की सूची के लिए फ़िल्टर संदर्भ देखें. | |
request.filters[].values[] |
list |
वैल्यू की सूची, जिससे कॉलम की वैल्यू को फ़िल्टर किया जा सकता है. हर अनुरोध के लिए, ज़्यादा से ज़्यादा 300 फ़िल्टर वैल्यू ही डाली जा सकती हैं. |
|
request.includeDeletedEntities |
boolean |
इससे तय होता है कि हटाई गई इकाइयों को रिपोर्ट में शामिल किया जाना चाहिए या नहीं. false पर डिफ़ॉल्ट. बहिष्कृत, कृपया इसके बजाय includeRemovedEntities का उपयोग करें. |
|
request.includeRemovedEntities |
boolean |
इससे तय होता है कि हटाई गई इकाइयों को रिपोर्ट में शामिल किया जाना चाहिए या नहीं. false पर डिफ़ॉल्ट. |
|
request.maxRowsPerFile |
integer |
सिर्फ़ एसिंक्रोनस रिपोर्ट. हर रिपोर्ट फ़ाइल में पंक्तियों की ज़्यादा से ज़्यादा संख्या. एक बड़ी रिपोर्ट को इस फ़ील्ड के आधार पर कई फ़ाइलों में बांटा जाता है. 1000000 से 100000000 तक के मान स्वीकार किए जाते हैं. |
|
request.orderBy[] |
list |
सिर्फ़ सिंक्रोनस रिपोर्ट. रिपोर्ट की लाइनों में, एक क्रम में लगाए जाने वाले कॉलम और निर्देशों की सूची. एक बार में 300 से ज़्यादा ऑर्डर नहीं किए जा सकते. |
|
request.orderBy[].column |
nested object |
क्रम से लगाने के लिए कॉलम. यह DoubleClick Search पर आधारित कोई कॉलम या सेव किया गया कॉलम हो सकता है. | |
request.orderBy[].column.columnName |
string |
रिपोर्ट में शामिल करने के लिए, DoubleClick खोज कॉलम का नाम. | |
request.orderBy[].column.customDimensionName |
string |
रिपोर्ट को कस्टम डाइमेंशन के हिसाब से सेगमेंट करता है. रिपोर्ट का दायरा, विज्ञापन देने वाले या उससे कम पर होना चाहिए. साथ ही, कस्टम डाइमेंशन पहले से ही DoubleClick Search में सेट अप होना चाहिए. DoubleClick खोज में दिखाई देने वाला कस्टम आयाम नाम, केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होता है. अगर इसका इस्तेमाल कन्वर्ज़न रिपोर्ट में किया जाता है, तो दिए गए कन्वर्ज़न के लिए तय किए गए कस्टम डाइमेंशन की वैल्यू दिखती है. ऐसा तब होता है, जब यह सेट हो. यह कॉलम, कन्वर्ज़न रिपोर्ट को सेगमेंट नहीं करता. |
|
request.orderBy[].column.customMetricName |
string |
रिपोर्ट में शामिल करने के लिए कस्टम मेट्रिक का नाम. रिपोर्ट, विज्ञापन देने वाले या उससे कम के दायरे में होनी चाहिए. साथ ही, कस्टम मेट्रिक पहले से ही DoubleClick Search में सेट अप होना चाहिए. DoubleClick खोज में दिखाई देने वाला कस्टम मेट्रिक नाम, केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होता है. | |
request.orderBy[].column.endDate |
string |
YYYY-MM-DD फ़ॉर्मैट में दिन शामिल है. अगर इसे दिया जाता है, तो इससे सिर्फ़ इस कॉलम की रिपोर्ट की कुल समयसीमा बदल जाती है. startDate के साथ दी जानी चाहिए. |
|
request.orderBy[].column.groupByColumn |
boolean |
सिर्फ़ सिंक्रोनस रिपोर्ट. true को इस कॉलम के हिसाब से ग्रुप करने के लिए सेट करें. false पर डिफ़ॉल्ट. |
|
request.orderBy[].column.headerText |
string |
रिपोर्ट आउटपुट में इस कॉलम की पहचान करने के लिए इस्तेमाल किया जाने वाला टेक्स्ट; तय न होने पर डिफ़ॉल्ट रूप से columnName या savedColumnName हो जाता है. इसका इस्तेमाल DoubleClick Search कॉलम और सेव किए गए कॉलम के बीच टकराव से बचने के लिए किया जा सकता है. |
|
request.orderBy[].column.platformSource |
string |
कस्टम डाइमेंशन के लिए डेटा देने के लिए इस्तेमाल किया जाने वाला प्लैटफ़ॉर्म. स्वीकार की जाने वाली वैल्यू "बाढ़ की रोशनी" है. | |
request.orderBy[].column.productReportPerspective |
string |
सिर्फ़ खास तरह की प्रॉडक्ट गतिविधि के लिए मेट्रिक दिखाता है. स्वीकार की जाने वाली वैल्यू ये हैं:
|
|
request.orderBy[].column.savedColumnName |
string |
सेव किए गए कॉलम का नाम, जिसे रिपोर्ट में शामिल करना है. रिपोर्ट का दायरा विज्ञापनदाता या उससे कम पर होना चाहिए और यह सहेजा गया स्तंभ पहले से DoubleClick खोज यूज़र इंटरफ़ेस (यूआई) में बनाया जाना चाहिए. | |
request.orderBy[].column.startDate |
string |
YYYY-MM-DD फ़ॉर्मैट में शामिल करने की तारीख. अगर इसे दिया जाता है, तो इससे सिर्फ़ इस कॉलम की रिपोर्ट की कुल समयसीमा बदल जाती है. endDate के साथ दी जानी चाहिए. |
|
request.orderBy[].sortOrder |
string |
क्रम से लगाने की दिशा, जो ascending या descending है. |
|
request.reportScope |
object |
रिपोर्टस्कोप, आईडी का एक सेट है, जिसका इस्तेमाल यह तय करने के लिए किया जाता है कि रिपोर्ट में इकाइयों का कौनसा सबसेट दिखाया जाएगा. सबसे निचले दायरे के आईडी से आईडी की पूरी वंशावली की ज़रूरत होती है जो एजेंसी के ज़रिए चाहिए. | |
request.reportScope.adGroupId |
long |
DS विज्ञापन समूह आईडी. | |
request.reportScope.adId |
long |
DS विज्ञापन आईडी. | |
request.reportScope.advertiserId |
long |
DS विज्ञापन देने वाले का आईडी. | |
request.reportScope.agencyId |
long |
DS एजेंसी आईडी. | |
request.reportScope.campaignId |
long |
DS कैंपेन आईडी. | |
request.reportScope.engineAccountId |
long |
DS इंजन खाता आईडी. | |
request.reportScope.keywordId |
long |
DS कीवर्ड आईडी. | |
request.reportType |
string |
इससे तय होता है कि रिपोर्ट में किस तरह की पंक्तियां दिखेंगी. उदाहरण के लिए, reportType: keyword डालने पर, रिपोर्ट की हर लाइन में किसी कीवर्ड का डेटा शामिल होगा. हर तरह के कॉलम के लिए उपलब्ध रिपोर्ट के टाइप रेफ़रंस देखें. |
|
request.rowCount |
integer |
सिर्फ़ सिंक्रोनस रिपोर्ट. लौटाने की पंक्तियों की अधिकतम संख्या; अतिरिक्त पंक्तियां छोड़ दी गई हैं. 0 से 10000 तक के मान स्वीकार किए जाते हैं. 10000 पर डिफ़ॉल्ट. |
|
request.startRow |
integer |
सिर्फ़ सिंक्रोनस रिपोर्ट. पहली पंक्ति की शून्य-आधारित इंडेक्स. 0 से 50000 तक के मान स्वीकार किए जाते हैं. 0 पर डिफ़ॉल्ट. |
|
request.statisticsCurrency |
string |
वह मुद्रा तय करता है जिसमें मुद्रा वापस की जाती है. संभावित वैल्यू ये हैं: usd , agency (अगर रिपोर्ट, एजेंसी या उससे पहले के दायरे में आती है, तो advertiser ), (अगर रिपोर्ट, * विज्ञापन देने वाले या इससे कम पर दायरे में है, तो मान्य है) या account (अगर रिपोर्ट, इंजन खाते या उससे पहले के दायरे में है, तो मान्य है). |
|
request.timeRange |
object |
अगर किसी रिपोर्ट में मेट्रिक के लिए अनुरोध किया जाता है, तो इस आर्ग्युमेंट का इस्तेमाल मेट्रिक की समयसीमा को सीमित करने के लिए किया जाएगा. | |
request.timeRange.changedAttributesSinceTimestamp |
datetime |
आरएफ़सी फ़ॉर्मैट में इनक्लूसिव यूटीसी टाइमस्टैंप, जैसे कि 2013-07-16T10:16:23.555Z . एट्रिब्यूट की बदली गई रिपोर्ट के काम करने के तरीके के बारे में ज़्यादा जानकारी देखें. |
|
request.timeRange.changedMetricsSinceTimestamp |
datetime |
आरएफ़सी फ़ॉर्मैट में इनक्लूसिव यूटीसी टाइमस्टैंप, जैसे कि 2013-07-16T10:16:23.555Z . मेट्रिक की बदली गई रिपोर्ट के काम करने के तरीके के बारे में ज़्यादा जानकारी देखें. |
|
request.timeRange.endDate |
string |
YYYY-MM-DD फ़ॉर्मैट में शामिल करने की तारीख. | |
request.timeRange.startDate |
string |
YYYY-MM-DD फ़ॉर्मैट में शामिल करने की तारीख. | |
request.verifySingleTimeZone |
boolean |
अगर true है, तो रिपोर्ट सिर्फ़ तब बनाई जाएगी, जब सभी ज़रूरी डेटा एक ही समय क्षेत्र से लिया गया हो. false पर डिफ़ॉल्ट. |
|
rowCount |
integer |
रिपोर्ट से जनरेट की गई रिपोर्ट पंक्तियों की संख्या, जिसमें हेडर शामिल नहीं हैं. | |
rows[] |
list |
सिर्फ़ सिंक्रोनस रिपोर्ट. जनरेट की गई रिपोर्ट पंक्तियां. | |
rows[].(key) |
any value |
यह उन कॉलम को दिखाता है जो इस लाइन में दिखते हैं. इसका मतलब है कि हर कुंजी, इस पंक्ति के खाली सेल वाले कॉलम से जुड़ी है. | |
statisticsCurrencyCode |
string |
रिपोर्ट में दी गई सभी मॉनेटरी वैल्यू का मुद्रा कोड. इसमें उपयोगकर्ताओं की सेट की गई वैल्यू (उदाहरण, कीवर्ड बोली सेटिंग) और मेट्रिक (उदाहरण के लिए, लागत और आय) शामिल हैं. रिपोर्ट का मुद्रा कोड, रिपोर्ट अनुरोध के statisticsCurrency फ़ील्ड से तय होता है. |
|
statisticsTimeZone |
string |
अगर किसी रिपोर्ट के सभी आंकड़े एक ही समय क्षेत्र से लिए गए हैं, तो बस यही होगा. नहीं तो, फ़ील्ड सेट नहीं होता है. |
तरीके
- जनरेट करें
- इससे रिपोर्ट तुरंत जनरेट होती है और वापस आती है.
- get
- रिपोर्ट अनुरोध की स्थिति के लिए पोल.
- getFile
- UTF-8 में एन्कोड की गई रिपोर्ट फ़ाइल डाउनलोड करता है.
- getIdMappingFile
- CSV फ़ाइल (UTF-8 में एन्कोड की गई) डाउनलोड करता है, जिसमें Search Ads 360 और नए Search Ads 360 के बीच आईडी की मैपिंग शामिल होती है. जिस विज्ञापन देने वाले को अनुरोध किया गया था उसकी फ़ाइल में Search Ads 360 और Search Ads 360 के पुराने वर्शन में मौजूद सभी चाइल्ड इकाइयां, जैसे कि इंजन खाते, कैंपेन, विज्ञापन ग्रुप वगैरह शामिल होती हैं.
- अनुरोध
- शिकायत करने के सिस्टम में, रिपोर्ट का अनुरोध शामिल करता है.