अगर आपने विज्ञापन देने वाले या इंजन खाते की छोटी से लेकर मॉडरेट करने वाली रिपोर्ट का अनुरोध किया है, तो सिर्फ़ एक सिंक्रोनस रिपोर्ट अनुरोध भेजा जा सकता है. अनुरोध के जवाब में Search Ads 360 API, पूरी रिपोर्ट को एक JSON ऑब्जेक्ट में दिखाएगा. सिंक्रोनस अनुरोध:
- सिर्फ़ विज्ञापन देने वाले और इंजन खाते की रिपोर्ट दिखाई जा सकती हैं
- Search Ads 360 की मदद से रिपोर्ट जनरेट होने तक, अपने क्लाइंट को ब्लॉक करें
अगर आपने विज्ञापन देने वाले किसी बड़े संगठन या इंजन-खाते की रिपोर्ट पाने का अनुरोध किया है, तो हमारा सुझाव है कि एसिंक्रोनस तरीका अपनाएं.
सिंक्रोनस अनुरोध करने के लिए
विज्ञापन देने वाले या इंजन खाते की रिपोर्ट में, आपको किस तरह का डेटा चाहिए, यह बताने के लिए Reports.generate() को कॉल करें.
Search Ads 360, अनुरोध की पुष्टि करता है, रिपोर्ट जनरेट करता है, और रिस्पॉन्स के मुख्य हिस्से में, रिपोर्ट को रिपोर्ट संसाधन के तौर पर दिखाता है.
सिंक्रोनस अनुरोध का उदाहरण
Reports.generate()
अनुरोध का एक उदाहरण नीचे दिया गया है.
JSON
POST https://www.googleapis.com/doubleclicksearch/v2/reports/generate
Authorization: Bearer your OAuth 2.0 access token
Content-type: application/json
{
"reportScope": {
"agencyId": "12300000000000456", // Replace with your ID
"advertiserId": "21700000000011523", // Replace with your ID
"engineAccountId": "700000000073991" // Replace with your ID
},
"reportType": "account", // This report covers all revenue and visits in the
// engine account specified in reportScope.
"columns": [
{ "columnName": "date" }, // The date column segments the report by individual days.
{ "columnName": "dfaRevenue" }, // Here are some metric columns available for keyword
{ // reports.
"columnName": "visits",
"startDate": "2013-01-01", // Each metric column can optionally specify its own start
"endDate": "2013-01-31", // and end date; by default the report timeRange is used.
"headerText": "January visits" // Every column can optionally specify a headerText, which
// changes the name of the column in the report.
}
],
"timeRange" : {
"startDate" : "2012-05-01", // Dates are inclusive and specified in YYYY-MM-DD format.
"endDate" : "2013-05-01"
// Alternatively, try the "changedMetricsSinceTimestamp" or "changedAttributesSinceTimestamp"
// options. See Incremental reports.
},
"statisticsCurrency": "agency", // Required. See Currency for statistics.
"verifySingleTimeZone": false, // Optional. Defaults to false. See Time zone.
"includeRemovedEntities": false // Optional. Defaults to false.
}
Java
public static void main(String[] args) throws Exception {
Doubleclicksearch service = getService(); // See Set Up Your Application.
Report report = generateAccountReport(service);
outputReport(report, "./");
}
/**
* Creates an account report using the synchronous Report.generate method.
*
* @throws IOException
*/
private static Report generateAccountReport(Doubleclicksearch service) throws IOException {
try {
return service.reports().generate(generateAccountRequest()).execute();
} catch (GoogleJsonResponseException e) {
System.err.println("Report request was rejected.");
for (ErrorInfo error : e.getDetails().getErrors()) {
System.err.println(error.getMessage());
}
System.exit(e.getStatusCode());
return null; // Unreachable code.
}
}
/**
* Creates a simple static request that lists the clicks and visits for an engine account. Use
* your own agency ID, advertiser ID, and engine account ID.
*/
private static ReportRequest generateAccountRequest() {
return new ReportRequest().setReportScope(
new ReportScope()
.setAgencyId(20700000000000451L) // Replace with your ID
.setAdvertiserId(21700000000010391L) // Replace with your ID
.setEngineAccountId(700000000042201L)) // Replace with your ID
.setReportType("account")
.setColumns(Arrays.asList(new ReportApiColumnSpec[] {
new ReportApiColumnSpec().setColumnName("date"),
new ReportApiColumnSpec().setColumnName("dfaRevenue"),
new ReportApiColumnSpec()
.setColumnName("visits")
.setHeaderText("January visits")
.setStartDate("2013-01-01")
.setEndDate("2013-01-31"),}))
.setTimeRange(new TimeRange()
.setStartDate("2012-05-01")
.setEndDate("2013-05-01"))
.setStatisticsCurrency("agency");
}
/**
* Outputs a synchronous report to a file.
*/
private static void outputReport(Report report, String localPath)
throws IOException {
FileOutputStream outputStream = new FileOutputStream(new File(localPath, "Report"));
final PrintStream printStream = new PrintStream(outputStream);
printStream.print(report);
printStream.close();
}
Python
def generate_report(service):
"""Generate and print sample report.
Args:
service: An authorized Doubleclicksearch service. See Set Up Your Application.
"""
request = service.reports().generate(
body=
{
"reportScope
"agencyId": "12300000000000456", // Replace with your ID
"advertiserId": "21700000000011523", // Replace with your ID
"engineAccountId": "700000000073991" // Replace with your ID
},
"reportType": "account",
"columns": [
{ "columnName": "date" },
{ "columnName": "dfaRevenue" },
{
"columnName": "visits",
"startDate": "2013-01-01",
"endDate": "2013-01-31",
"headerText": "January visits"
}
],
"timeRange" : {
"startDate" : "2012-05-01",
"endDate" : "2013-05-01"
},
"statisticsCurrency": "agency",
"verifySingleTimeZone": "false",
"includeRemovedEntities": "false"
}
)
pprint.pprint(request.execute())
उदाहरण के तौर पर दी गई रिपोर्ट
सिंक्रोनस अनुरोध का जवाब एक रिपोर्ट ऑब्जेक्ट होता है.
अगर अनुरोध की पुष्टि हो जाती है, तो ऑब्जेक्ट की पहली कुछ प्रॉपर्टी में मेटाडेटा मौजूद होता है.
इस मेटाडेटा में आपके सबमिट किए गए अनुरोध की जानकारी होती है. रिपोर्ट अपने-आप ऑब्जेक्ट की rows
प्रॉपर्टी में होती है.
{
"kind":"doubleclicksearch#report",
"request":{
"columns":[
{"columnName":"date"},
{"columnName":"dfaRevenue"},
{"columnName":"visits","endDate":"2013-01-31","headerText":"visits last month","startDate":"2013-01-01"}
],
"includeDeletedEntities":false,
"reportScope":{
"agencyId":"12300000000000456",
"advertiserId":"21700000000011523",
"engineAccountId":"700000000073991"
},
"reportType":"account",
"rowCount":10000,
"startRow":0,
"statisticsCurrency":"agency",
"timeRange":{
"endDate":"2013-05-01",
"startDate":"2012-05-01"
}
},
"rowCount":366,
"rows":[
{
"date":"2012-05-01",
"dfaRevenue":0.0,
"visits last month":0.0
},
{
"date":"2012-05-02",
"dfaRevenue":0.0,
"visits last month":0.0
},
{
"date":"2012-05-03",
"dfaRevenue":0.0,
"visits last month":0.0
},
{
"date":"2012-05-04",
"dfaRevenue":0.0,
"visits last month":0.0
},
...
]
}
अगर पुष्टि नहीं हो पाती है
अगर रिपोर्ट की पुष्टि नहीं हो पाती है, तो Search Ads 360 गड़बड़ी ऑब्जेक्ट के साथ एचटीटीपी 400 रिस्पॉन्स
दिखाता है. उदाहरण के लिए, ऊपर दिए गए उदाहरण में, किसी असली एजेंसी के बारे में नहीं बताया गया है:
{
"error": {
"code": 400,
"message": "statisticsCurrency: the agency in scope does not have a valid currency. Please make sure the agency is properly initialized in Search Ads 360."
}
}
सिंक्रोनस रिपोर्ट को एक से ज़्यादा जवाबों में बांटना
डिफ़ॉल्ट रूप से, सिंक्रोनस अनुरोध पहली 10,000 पंक्तियां दिखाता है. इस व्यवहार को बदलने के लिए,
हर अनुरोध के साथ रिपोर्ट के खास हिस्सों को
फिर से पाने के लिए, Reports.request.startRow
और Reports.request.rowCount
प्रॉपर्टी का इस्तेमाल करें.
सिंक्रोनस रिपोर्ट को बांटने का उदाहरण
उदाहरण के लिए, यह अनुरोध दिन के हिसाब से सेगमेंट की गई किसी एजेंसी की रिपोर्ट की पहली सौ पंक्तियां (0 से 99) दिखाएगा:
{
"reportScope": {
"agencyId": "12300000000000456", // Replace with your ID
"advertiserId": "21700000000011523", // Replace with your ID
"engineAccountId": "700000000073991" // Replace with your ID
},
"reportType": "account",
"columns": [
{ "columnName": "date" },
{ "columnName": "dfaRevenue" }
],
"timeRange" : {
"startDate" : "2012-05-01",
"endDate" : "2013-05-01"
},
"startRow":"0",
"rowCount":"100",
"statisticsCurrency": "agency",
"verifySingleTimeZone": false,
"includeRemovedEntities": false
}
इस अनुरोध को लाइन 100 से 199 के लिए, किसी दूसरे अनुरोध के साथ फ़ॉलो किया जा सकता है:
{
"reportScope": {
"agencyId": "12300000000000456", // Replace with your ID
"advertiserId": "21700000000011523", // Replace with your ID
"engineAccountId": "700000000073991" // Replace with your ID
},
"reportType": "account",
"columns": [
{ "columnName": "date" },
{ "columnName": "dfaRevenue" }
],
"timeRange" : {
"startDate" : "2012-05-01",
"endDate" : "2013-05-01"
},
"startRow":"100",
"rowCount":"100",
"statisticsCurrency": "agency",
"verifySingleTimeZone": false,
"includeRemovedEntities": false
}