रिपोर्ट तुरंत जनरेट करके दिखाता है. इसे अभी आज़माएं.
अनुरोध
एचटीटीपी अनुरोध
POST https://www.googleapis.com/doubleclicksearch/v2/reports/generate
अनुमति देना
इस अनुरोध के लिए, नीचे दिए गए स्कोप वाले अनुमति की ज़रूरत है:
दायरा |
---|
https://www.googleapis.com/auth/doubleclicksearch |
ज़्यादा जानकारी के लिए, पुष्टि करने और अनुमति देने से जुड़ा पेज देखें.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर के साथ डेटा उपलब्ध कराएं:
{ "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 }
प्रॉपर्टी का नाम | मान | ब्यौरा | नोट |
---|---|---|---|
reportScope |
object |
रिपोर्ट का दायरा, आईडी का एक सेट है. इसका इस्तेमाल यह तय करने के लिए किया जाता है कि रिपोर्ट में इकाइयों का कौनसा सबसेट दिखाया जाएगा. एजेंसी के ज़रिए, सबसे निचले दायरे वाले लेवल के आईडी की पूरी लीनेज ज़रूरी है. | |
reportScope.agencyId |
long |
DS एजेंसी आईडी. | |
reportScope.advertiserId |
long |
DS ऐडवर्टाइज़र आईडी. | |
reportScope.engineAccountId |
long |
DS इंजन खाता आईडी. | |
reportScope.campaignId |
long |
DS कैंपेन आईडी. | |
reportScope.adGroupId |
long |
DS विज्ञापन ग्रुप आईडी. | |
reportScope.keywordId |
long |
DS कीवर्ड आईडी. | |
reportScope.adId |
long |
DS विज्ञापन आईडी. | |
reportType |
string |
इससे रिपोर्ट में दिखने वाली लाइनों का टाइप तय होता है. उदाहरण के लिए, reportType: keyword तय करने पर, रिपोर्ट की हर लाइन में कीवर्ड से जुड़ा डेटा होगा. हर टाइप के लिए उपलब्ध कॉलम के रिपोर्ट टाइप रेफ़रंस देखें. |
|
columns[] |
list |
रिपोर्ट में शामिल किए जाने वाले कॉलम. इसमें DoubleClick खोज कॉलम और सेव किए गए कॉलम, दोनों शामिल हैं. DoubleClick खोज कॉलम के लिए सिर्फ़ columnName पैरामीटर ज़रूरी है. सेव किए गए कॉलम के लिए, सिर्फ़ savedColumnName पैरामीटर ज़रूरी है. columnName और savedColumnName , दोनों को एक ही पद में सेट नहीं किया जा सकता. हर अनुरोध में कॉलम की संख्या ज़्यादा से ज़्यादा 300 हो सकती है. |
|
columns[].columnName |
string |
रिपोर्ट में शामिल करने के लिए, DoubleClick Search कॉलम का नाम. | |
columns[].savedColumnName |
string |
रिपोर्ट में शामिल करने के लिए, सेव किए गए कॉलम का नाम. रिपोर्ट का दायरा, विज्ञापन देने वाले या उससे कम के दायरे में होना चाहिए. साथ ही, सेव किया गया यह कॉलम, DoubleClick Search के यूज़र इंटरफ़ेस (यूआई) में पहले से बनाया जाना चाहिए. | |
columns[].headerText |
string |
रिपोर्ट आउटपुट में इस कॉलम के बारे में बताने के लिए इस्तेमाल किया गया टेक्स्ट; तय न होने पर, डिफ़ॉल्ट रूप से columnName या savedColumnName हो जाता है. इसका इस्तेमाल DoubleClick खोज कॉलम और समान नाम वाले सेव किए गए कॉलम के बीच टकराव रोकने के लिए किया जा सकता है. |
|
columns[].startDate |
string |
शामिल होने की तारीख YYYY-MM-DD फ़ॉर्मैट में होनी चाहिए. यह वैल्यू दिए जाने पर, सिर्फ़ इस कॉलम के लिए रिपोर्ट की समयसीमा बदल जाती है. endDate के साथ दिया जाना चाहिए. |
|
columns[].endDate |
string |
दिन की जानकारी, YYYY-MM-DD फ़ॉर्मैट में होनी चाहिए. यह वैल्यू दिए जाने पर, सिर्फ़ इस कॉलम के लिए रिपोर्ट की समयसीमा बदल जाती है. startDate के साथ दिया जाना चाहिए. |
|
columns[].groupByColumn |
boolean |
सिर्फ़ सिंक्रोनस रिपोर्ट. इस कॉलम के हिसाब से ग्रुप करने के लिए, true पर सेट करें. डिफ़ॉल्ट तौर पर, यह false पर सेट होता है. |
|
timeRange |
object |
अगर किसी रिपोर्ट में मेट्रिक का अनुरोध किया जाता है, तो इस आर्ग्युमेंट का इस्तेमाल, मेट्रिक को किसी खास समयसीमा के लिए सीमित करने के लिए किया जाएगा. | |
timeRange.startDate |
string |
शामिल होने की तारीख YYYY-MM-DD फ़ॉर्मैट में होनी चाहिए. | |
timeRange.endDate |
string |
शामिल होने की तारीख YYYY-MM-DD फ़ॉर्मैट में होनी चाहिए. | |
timeRange.changedMetricsSinceTimestamp |
datetime |
आरएफ़सी फ़ॉर्मैट में शामिल यूटीसी टाइमस्टैंप, जैसे कि 2013-07-16T10:16:23.555Z . बदली गई मेट्रिक रिपोर्ट कैसे काम करती हैं, इस बारे में ज़्यादा जानकारी देखें. |
|
timeRange.changedAttributesSinceTimestamp |
datetime |
आरएफ़सी फ़ॉर्मैट में शामिल यूटीसी टाइमस्टैंप, जैसे कि 2013-07-16T10:16:23.555Z . इस बारे में अतिरिक्त रेफ़रंस देखें कि एट्रिब्यूट की बदली गई रिपोर्ट कैसे काम करती हैं. |
|
filters[] |
list |
रिपोर्ट पर लागू किए जाने वाले फ़िल्टर की सूची. एक अनुरोध में ज़्यादा से ज़्यादा 300 फ़िल्टर जोड़े जा सकते हैं. |
|
filters[].column |
nested object |
फ़िल्टर करने के लिए कॉलम. यह DoubleClick खोज कॉलम या सेव किया गया कॉलम हो सकता है. | |
filters[].column.columnName |
string |
रिपोर्ट में शामिल करने के लिए, DoubleClick Search कॉलम का नाम. | |
filters[].column.savedColumnName |
string |
रिपोर्ट में शामिल करने के लिए, सेव किए गए कॉलम का नाम. रिपोर्ट का दायरा, विज्ञापन देने वाले या उससे कम के दायरे में होना चाहिए. साथ ही, सेव किया गया यह कॉलम, DoubleClick Search के यूज़र इंटरफ़ेस (यूआई) में पहले से बनाया जाना चाहिए. | |
filters[].operator |
string |
फ़िल्टर में इस्तेमाल करने के लिए ऑपरेटर. उपलब्ध ऑपरेटर की सूची के लिए फ़िल्टर रेफ़रंस देखें. | |
filters[].values[] |
list |
कॉलम की वैल्यू को फ़िल्टर करने के लिए, वैल्यू की सूची. हर अनुरोध के लिए, फ़िल्टर वैल्यू की ज़्यादा से ज़्यादा 300 वैल्यू डाली जा सकती हैं. |
|
orderBy[] |
list |
सिर्फ़ सिंक्रोनस रिपोर्ट. रिपोर्ट की लाइनों में लागू होने वाले कॉलम और दिशा-निर्देशों की सूची, जिससे क्रम तय होता है. एक बार में 300 से ज़्यादा ऑर्डर नहीं किए जा सकते. |
|
orderBy[].column |
nested object |
क्रम से लगाने के लिए कॉलम. यह DoubleClick Search का तय किया गया कॉलम या सेव किया गया कॉलम हो सकता है. | |
orderBy[].column.columnName |
string |
रिपोर्ट में शामिल करने के लिए, DoubleClick Search कॉलम का नाम. | |
orderBy[].column.savedColumnName |
string |
रिपोर्ट में शामिल करने के लिए, सेव किए गए कॉलम का नाम. रिपोर्ट का दायरा, विज्ञापन देने वाले या उससे कम के दायरे में होना चाहिए. साथ ही, सेव किया गया यह कॉलम, DoubleClick Search के यूज़र इंटरफ़ेस (यूआई) में पहले से बनाया जाना चाहिए. | |
orderBy[].sortOrder |
string |
क्रम से लगाने की दिशा, जो या तो ascending या descending है. |
|
includeDeletedEntities |
boolean |
इससे तय होता है कि हटाई गई इकाइयों को रिपोर्ट में शामिल किया जाना चाहिए या नहीं. डिफ़ॉल्ट तौर पर, यह false पर सेट होता है. यह अब काम नहीं करता, इसलिए कृपया इसके बजाय includeRemovedEntities का इस्तेमाल करें. |
|
verifySingleTimeZone |
boolean |
अगर true , तो अनुरोध किए गए सभी आंकड़ों का डेटा एक ही टाइमज़ोन से लिए जाने पर ही रिपोर्ट बनाई जाएगी. डिफ़ॉल्ट तौर पर, यह false पर सेट होता है. |
|
downloadFormat |
string |
वह फ़ॉर्मैट जिसमें रिपोर्ट दिखती है. फ़िलहाल, csv या tsv इस्तेमाल किया जा सकता है. |
|
statisticsCurrency |
string |
उस मुद्रा के बारे में बताता है जिसमें कमाई करनी है. संभावित वैल्यू ये हैं: usd , agency (अगर रिपोर्ट, एजेंसी या उससे नीचे के दायरे में है, तो मान्य है), advertiser (अगर रिपोर्ट, * विज्ञापन देने वाले या उससे कम के दायरे में आती है) या account (अगर रिपोर्ट का दायरा, इंजन खाते या उससे नीचे के दायरे में है, तो मान्य है) के लिए मान्य है. |
|
startRow |
integer |
सिर्फ़ सिंक्रोनस रिपोर्ट. दी जाने वाली पहली पंक्ति का शून्य-आधारित इंडेक्स. स्वीकार की जाने वाली वैल्यू 0 से 50000 तक हैं. इसमें ये वैल्यू भी शामिल हैं. डिफ़ॉल्ट तौर पर, यह 0 पर सेट होता है. |
|
rowCount |
integer |
सिर्फ़ सिंक्रोनस रिपोर्ट. दिखाई जाने वाली पंक्तियों की ज़्यादा से ज़्यादा संख्या; अतिरिक्त पंक्तियां छोड़ दी जाती हैं. स्वीकार की जाने वाली वैल्यू 0 से 10000 तक हैं. इसमें ये वैल्यू भी शामिल हैं. डिफ़ॉल्ट तौर पर, यह 10000 पर सेट होता है. |
|
maxRowsPerFile |
integer |
सिर्फ़ एसिंक्रोनस रिपोर्ट. हर रिपोर्ट फ़ाइल में ज़्यादा से ज़्यादा लाइन की संख्या. इस फ़ील्ड के आधार पर, एक बड़ी रिपोर्ट को कई फ़ाइलों में बांटा जाता है. स्वीकार की जाने वाली वैल्यू 1000000 से 100000000 तक होनी चाहिए. इसमें ये वैल्यू भी शामिल हैं. |
|
includeRemovedEntities |
boolean |
इससे तय होता है कि हटाई गई इकाइयों को रिपोर्ट में शामिल किया जाना चाहिए या नहीं. डिफ़ॉल्ट तौर पर, यह false पर सेट होता है. |
|
columns[].customDimensionName |
string |
कस्टम डाइमेंशन के आधार पर रिपोर्ट को सेगमेंट करता है. रिपोर्ट का दायरा किसी विज्ञापन देने वाले या उससे कम के दायरे में होना चाहिए. साथ ही, कस्टम डाइमेंशन को DoubleClick Search में पहले से सेट अप करना ज़रूरी है. DoubleClick खोज में दिखाई देने वाला कस्टम डाइमेंशन का नाम केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होता है. अगर किसी कन्वर्ज़न रिपोर्ट में इस्तेमाल किया जाता है, तो दिए गए कन्वर्ज़न के लिए, तय किया गया कस्टम डाइमेंशन सेट करता है. यह कॉलम कन्वर्ज़न रिपोर्ट को सेगमेंट में नहीं बांटता. |
|
columns[].platformSource |
string |
वह प्लैटफ़ॉर्म जिसका इस्तेमाल कस्टम डाइमेंशन के लिए डेटा देने के लिए किया जाता है. इसके लिए, "floodlight" वैल्यू स्वीकार की जाती हैं. | |
filters[].column.customDimensionName |
string |
कस्टम डाइमेंशन के आधार पर रिपोर्ट को सेगमेंट करता है. रिपोर्ट का दायरा किसी विज्ञापन देने वाले या उससे कम के दायरे में होना चाहिए. साथ ही, कस्टम डाइमेंशन को DoubleClick Search में पहले से सेट अप करना ज़रूरी है. DoubleClick खोज में दिखाई देने वाला कस्टम डाइमेंशन का नाम केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होता है. अगर किसी कन्वर्ज़न रिपोर्ट में इस्तेमाल किया जाता है, तो दिए गए कन्वर्ज़न के लिए, तय किया गया कस्टम डाइमेंशन सेट करता है. यह कॉलम कन्वर्ज़न रिपोर्ट को सेगमेंट में नहीं बांटता. |
|
filters[].column.headerText |
string |
रिपोर्ट आउटपुट में इस कॉलम के बारे में बताने के लिए इस्तेमाल किया गया टेक्स्ट; तय न होने पर, डिफ़ॉल्ट रूप से columnName या savedColumnName हो जाता है. इसका इस्तेमाल DoubleClick खोज कॉलम और समान नाम वाले सेव किए गए कॉलम के बीच टकराव रोकने के लिए किया जा सकता है. |
|
filters[].column.startDate |
string |
शामिल होने की तारीख YYYY-MM-DD फ़ॉर्मैट में होनी चाहिए. यह वैल्यू दिए जाने पर, सिर्फ़ इस कॉलम के लिए रिपोर्ट की समयसीमा बदल जाती है. endDate के साथ दिया जाना चाहिए. |
|
filters[].column.endDate |
string |
दिन की जानकारी, YYYY-MM-DD फ़ॉर्मैट में होनी चाहिए. यह वैल्यू दिए जाने पर, सिर्फ़ इस कॉलम के लिए रिपोर्ट की समयसीमा बदल जाती है. startDate के साथ दिया जाना चाहिए. |
|
filters[].column.groupByColumn |
boolean |
सिर्फ़ सिंक्रोनस रिपोर्ट. इस कॉलम के हिसाब से ग्रुप करने के लिए, true पर सेट करें. डिफ़ॉल्ट तौर पर, यह false पर सेट होता है. |
|
filters[].column.platformSource |
string |
वह प्लैटफ़ॉर्म जिसका इस्तेमाल कस्टम डाइमेंशन के लिए डेटा देने के लिए किया जाता है. इसके लिए, "floodlight" वैल्यू स्वीकार की जाती हैं. | |
orderBy[].column.customDimensionName |
string |
कस्टम डाइमेंशन के आधार पर रिपोर्ट को सेगमेंट करता है. रिपोर्ट का दायरा किसी विज्ञापन देने वाले या उससे कम के दायरे में होना चाहिए. साथ ही, कस्टम डाइमेंशन को DoubleClick Search में पहले से सेट अप करना ज़रूरी है. DoubleClick खोज में दिखाई देने वाला कस्टम डाइमेंशन का नाम केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होता है. अगर किसी कन्वर्ज़न रिपोर्ट में इस्तेमाल किया जाता है, तो दिए गए कन्वर्ज़न के लिए, तय किया गया कस्टम डाइमेंशन सेट करता है. यह कॉलम कन्वर्ज़न रिपोर्ट को सेगमेंट में नहीं बांटता. |
|
orderBy[].column.headerText |
string |
रिपोर्ट आउटपुट में इस कॉलम के बारे में बताने के लिए इस्तेमाल किया गया टेक्स्ट; तय न होने पर, डिफ़ॉल्ट रूप से columnName या savedColumnName हो जाता है. इसका इस्तेमाल DoubleClick खोज कॉलम और समान नाम वाले सेव किए गए कॉलम के बीच टकराव रोकने के लिए किया जा सकता है. |
|
orderBy[].column.startDate |
string |
शामिल होने की तारीख YYYY-MM-DD फ़ॉर्मैट में होनी चाहिए. यह वैल्यू दिए जाने पर, सिर्फ़ इस कॉलम के लिए रिपोर्ट की समयसीमा बदल जाती है. endDate के साथ दिया जाना चाहिए. |
|
orderBy[].column.endDate |
string |
दिन की जानकारी, YYYY-MM-DD फ़ॉर्मैट में होनी चाहिए. यह वैल्यू दिए जाने पर, सिर्फ़ इस कॉलम के लिए रिपोर्ट की समयसीमा बदल जाती है. startDate के साथ दिया जाना चाहिए. |
|
orderBy[].column.groupByColumn |
boolean |
सिर्फ़ सिंक्रोनस रिपोर्ट. इस कॉलम के हिसाब से ग्रुप करने के लिए, true पर सेट करें. डिफ़ॉल्ट तौर पर, यह false पर सेट होता है. |
|
orderBy[].column.platformSource |
string |
वह प्लैटफ़ॉर्म जिसका इस्तेमाल कस्टम डाइमेंशन के लिए डेटा देने के लिए किया जाता है. इसके लिए, "floodlight" वैल्यू स्वीकार की जाती हैं. | |
columns[].customMetricName |
string |
रिपोर्ट में शामिल करने के लिए, कस्टम मेट्रिक का नाम. रिपोर्ट का दायरा किसी विज्ञापन देने वाले या उससे कम के दायरे में होना चाहिए. साथ ही, कस्टम मेट्रिक को DoubleClick Search में पहले से सेट अप करना ज़रूरी है. DoubleClick खोज में दिखाई देने वाला कस्टम मेट्रिक नाम केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होता है. | |
filters[].column.customMetricName |
string |
रिपोर्ट में शामिल करने के लिए, कस्टम मेट्रिक का नाम. रिपोर्ट का दायरा किसी विज्ञापन देने वाले या उससे कम के दायरे में होना चाहिए. साथ ही, कस्टम मेट्रिक को DoubleClick Search में पहले से सेट अप करना ज़रूरी है. DoubleClick खोज में दिखाई देने वाला कस्टम मेट्रिक नाम केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होता है. | |
orderBy[].column.customMetricName |
string |
रिपोर्ट में शामिल करने के लिए, कस्टम मेट्रिक का नाम. रिपोर्ट का दायरा किसी विज्ञापन देने वाले या उससे कम के दायरे में होना चाहिए. साथ ही, कस्टम मेट्रिक को DoubleClick Search में पहले से सेट अप करना ज़रूरी है. DoubleClick खोज में दिखाई देने वाला कस्टम मेट्रिक नाम केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होता है. | |
columns[].productReportPerspective |
string |
यह फ़ंक्शन सिर्फ़ प्रॉडक्ट से जुड़ी किसी खास तरह की गतिविधि के लिए मेट्रिक दिखाता है. ये मान स्वीकार किए जाते हैं:
|
|
filters[].column.productReportPerspective |
string |
यह फ़ंक्शन सिर्फ़ प्रॉडक्ट से जुड़ी किसी खास तरह की गतिविधि के लिए मेट्रिक दिखाता है. ये मान स्वीकार किए जाते हैं:
|
|
orderBy[].column.productReportPerspective |
string |
यह फ़ंक्शन सिर्फ़ प्रॉडक्ट से जुड़ी किसी खास तरह की गतिविधि के लिए मेट्रिक दिखाता है. ये मान स्वीकार किए जाते हैं:
|
जवाब
अगर यह तरीका काम करता है, तो जवाब के मुख्य हिस्से में यह रिपोर्ट संसाधन दिखाता है.
इसे आज़माएं!
लाइव डेटा पर इस तरीके को कॉल करने और जवाब देखने के लिए, नीचे दिए गए एपीआई एक्सप्लोरर का इस्तेमाल करें. वैकल्पिक रूप से, यह आज़माएं स्टैंडअलोन एक्सप्लोरर.