The previous Search Ads 360 Reporting API is decommissioned. You can now create your reports using the new Search Ads 360 Reporting API.

Note that the Search Ads 360 Conversion API is not affected and will continue to be supported.

Reporting FAQ

The new Search Ads 360 Reporting API is now available. The new API provides enhanced flexibility to build custom reports and integrate the data into your reporting applications and processes. Learn more about migrating to and using the new Search Ads 360 Reporting API.

What should my report scope be?

For most reports, we recommend that you set Reports.reportScope to a specific engine account or advertiser. For very large reports—such as keyword reports, conversion reports, or finely-segmented reports—we recommend limiting the scope to a specific engine account. The API may return errors for reports larger than 10 million rows.

Why am I receiving a Forbidden (403) error?

Most likely, you need to obtain a refresh OAuth token.

How do I find IDs for agencies and advertisers?

If you don't already have the IDs for the agencies and advertisers you have permission to view, request an advertiser report with the agencyId and advertiserId columns, but don't specify the reportScope. Search Ads 360 will return a list of all agency and advertiser IDs that your Google Account has permission to view.

Here's an example request:

POST  https://www.googleapis.com/doubleclicksearch/v2/reports/generate
Authorization: Bearer your OAuth 2.0 access token
Content-type: application/json
{
  "reportType": "advertiser",
  "columns": [
    { "columnName": "agency" },
    { "columnName": "agencyId" },
    { "columnName": "advertiser" },
    { "columnName": "advertiserId" }
  ],
  "statisticsCurrency": "usd"
}

Use the Search Ads 360 utility script to send this request

To send a raw JSON POST request, you can use the sa360Api.py script as follows:

Copy the example JSON object (everything between and including the two curly brackets) into a new text file named request.txt.
Change the agency ID that's in the JSON code to your own agency ID.
Remove any comments, such as // The date column segments the report by individual days.
Assemble your OAuth 2.0 credentials into a single, comma-delimited string as follows:
client-ID,client-secret,refresh-token
(This is the same string that sa360Api.py outputs when you run sa360Api.py --login as described in Set Up Authorization.)
Invoke sa360Api.py as follows:
sa360Api.py --cred CREDENTIALS --server API-method --post < request.txt
In the command above, substitute the string you assembled in the previous step for CREDENTIALS.
Substitute the name of the POST method in the box below for API-method.
For example:
sa360Api.py --cred 123456789123.apps.googleusercontent.com,ABCDEFGHIJKLMNOPQR_abcdef,1/HIJklM01OPQR23NOP456rst890uvw --server https://www.googleapis.com/doubleclicksearch/v2/reports/generate --post < request.txt

How fresh is the reporting data?

Some metrics are fresher than others. For details, see how fresh is the reporting data in Search Ads 360?

To make sure your reports contain all available metrics, we recommend waiting about 4 hours after midnight (engine account time zone) before requesting reports of yesterday's metrics; for the conversion report, we recommend waiting for 12 hours after midnight (Campaign Manager advertiser time zone). If you use the API to upload conversion data, see insert.operation for details about the availability of uploaded data.

Even after several days, a metric can still change due to engine spam filters or offline conversions being uploaded via the API. To incrementally download these changes, request reports on the data that has changed since your last download. If you download incremental changes, we recommend that you request a full report every once in awhile. For example, you might download incremental changes every few days and then request a full report once a month.

When will attribute changes appear in reports?

It takes about a minute for attribute changes that someone makes in Search Ads 360 to appear in reports that you download via the API. Changes made directly on the external engine (not through Search Ads 360) will need to be imported into Search Ads 360 first using inbound sync.

We recommend returning only the data that has changed to determine which entities have attribute changes.

What are unattributed ads and keywords?

Sometimes Search Ads 360 cannot attribute metrics to a specific ad. For example, an ad with an unsupported format or a clickserver URL with an error can prevent Search Ads 360 from attributing metrics to an ad. For each ad group, Search Ads 360 reports any unattributed metrics as belonging to an "unattributed ad." To request these metrics in a report, set includeRemovedEntities to true. To make it easy to see which ads are unattributed, include the isUnattributedAd column in the request.

Similarly, at times Search Ads 360 cannot attribute metrics to a specific keyword. This happens when discrepancies in reporting arise. In such cases, the keywordId column for unattributed keywords is set to 0.

Do reports include scaled conversions?

In some cases, conversions are hard to measure, such as when the website cookies that store information about your ad clicks aren't available due to factors including browser settings. In these cases, Floodlight uses scaling to account for the conversion data that can't be directly measured. That is, Floodlight applies machine learning to historical data to model the number of conversions and amount of conversion revenue that cannot be measured. Floodlight can then add the resulting estimate to its conversion metrics to provide a more complete picture of how your advertising drives conversions.

Floodlight always applies scaling to the following reporting columns:

dfaActions
dfaRevenue
dfaTransactions
dfaWeightedActions
Saved columns that report on Floodlight activities

The conversion report does not include scaled conversions. It only shows conversions that were measured directly. The number of conversions and amount of revenue in a conversion report are not expected to match the conversions and revenue reported in the columns listed above.

Why do raw conversions not sum up to aggregated metric X?

In the rare event that aggregated metrics disagree with raw events in Search Ads 360, trust the aggregated metric. When computing metric aggregates, Search Ads 360 attempts to sanitize data sources by removing conversions that it suspects are duplicates.

What if my question isn't answered here?

If there's a problem that you can't solve after reading the resources on this site, contact support and have the following information ready:

Search Ads 360 Agency ID and Advertiser ID you are trying to access
Project Number from Google API Console
The username of the Google Account that you’re using to access the API.
This is the account that has been given permission to access Search Ads 360, which is the same account you use to set up authorization.
Code snippet of your request
JSON response
If the response is an error, be sure to include the error message, not just the numeric error code.