GetOfflineReportList (Live)

Returns a list of reports on dynamic text ads that have been created or are being generated.

Attention. Disabled method. Use version 5 of the API.

Input data

The input data structure in JSON is shown below.

{
   "method": "GetOfflineReportList"
}

Output data

The method returns an array of OfflineReportInfo objects, each of which contains information about a single report. The array can have a total of up to five objects. The array is sorted by decreasing Id. The output data structure in JSON is shown below.

{
   "data": [
      {  /* OfflineReportInfo */
         "Type": (string),
         "Id": (int),
         "Status": (string),
         "Url": (string)
      }
      ...
   ]
}

Parameters are described below.

Parameter Description
OfflineReportInfo object
Type The campaign type that the report was generated for: dynamic_text_ad.
Id ID of the report.
Status

Report status:

  • Done — Report has been generated.
  • Pending — Report is in progress.
  • Failed — Report was not generated.
Url Link for downloading the report from the server. Returned if the report was created successfully. The report is accessible over the HTTPS protocol.

Sample report

The report is generated in text/tab-separated-values format.

Note.

The first row of the report contains the names of fields.

A sample report is shown below.

Date CampaignName CampaignId AdGroupName AdGroupId AdId Title Text Url SearchQuery Impressions Clicks CTR Cost AvgClickCost AvgDepth Conversion AvgGoalCost GoalsNum
31.08.2015 Dynamic ad campaign 12345 Group of dynamic ads 98765 7654321 Rowenta Focus Iron DW6020D1 You'll enjoy buying irons! http://www.example.com/irons/rowenta/dw6020d1 buy iron rowenta 133 24 0.180451127819549 191.778 7.99075 1 1 47.9445 4
31.08.2015 Dynamic ad campaign 12345 Group of dynamic ads 98765 7654321 Philips steamer GC660/05 You'll enjoy buying irons! http://www.example.com/irons/philips/gc660/05 How to choose a steamer 200 43 0.215 296.38 6.89255813953488 1.4 1 59.276 5

Parameters are described below.

Parameter Description
Date

The data statistics are provided for.

If the GroupByDate input parameter has the value “week” or “month”, the first date of the week or month is specified.

CampaignName The campaign name.
CampaignId The campaign ID.
AdGroupName Name of the ad group.
AdGroupId ID of the ad group.
AdId The ad ID.
Title Ad title.
Text Ad text.
Url Ad link.
SearchQuery

The search query that triggered the ad.

Impressions Number of impressions in the search.
Clicks Number of clicks in the search.
CTR The ratio of clicks on an ad to the number of impressions (click-through rate).
Cost The cost per click on search (in the campaign currency).
AvgClickCost The average CPC: the ratio of the cost of clicks (in the campaign currency) to the number of clicks.
AvgDepth Average session depth on the advertiser's site.
Conversion The ratio of conversions to the total number of sessions.
AvgGoalCost The average cost of reaching a goal: the ratio of the cost of clicks (in the campaign currency) to the number of conversions.
GoalsNum The number of conversions.

Report data is grouped by the values of the fields Date, CampaignName, CampaignId, AdGroupName, AdGroupId, AdId, Title, Text, Url and SearchQuery.