Monitor upload summaries

Starting with v14 of the Google Ads API, you can query the offline_conversion_client_summaries field to retrieve information about the overall health of your upload processes.

SELECT
  customer.id,
  customer.conversion_tracking_setting.google_ads_conversion_customer,
  customer.offline_conversion_client_summaries
FROM customer

The offline_conversion_client_summaries field contains a separate OfflineConversionClientSummary for each type of client used in recent uploads. For example, if you recently uploaded using both the Google Ads API and the Google Ads UI, the offline_conversion_client_summaries will contain separate entries for the client values of GOOGLE_ADS_API and GOOGLE_ADS_WEB_CLIENT.

Each OfflineConversionClientSummary has a status field that reflects the overall health of uploads for the client. It also contains the count of total events received, the count of successfully processed events, and an alerts field that provides a summary of errors, grouped by OfflineConversionUploadError. All of these fields contain information from the most recent full calendar day of uploads. Use this information to assess the current health of your uploads.

In addition, each OfflineConversionClientSummary contains two different types of reports:

daily_summaries

A successful_count and failed_count of upload requests from the last 7 days, grouped by upload date.

job_summaries

The successful_count and failed_count of the 7 most recent upload requests, grouped by job_id.

UploadClickConversionsResponse and UploadConversionAdjustmentsResponse contain a system-generated job_id. Record these values during your upload process if you want to join your job_summaries with specific upload requests.

How to use summaries

To ensure your upload processes are recording conversions and enhancements as expected, periodically retrieve the summaries for each of your accounts. If the status of any summary is not EXCELLENT, use the list of errors under alerts to guide you through modifying your upload process to reduce or eliminate those errors.

For example:

• If the status is NEEDS_ATTENTION, then a significant portion of your upload operations failed. Review the errors under alerts and modify your upload process to reduce or eliminate those errors.

• If the status is NO_RECENT_UPLOADS, then Google Ads has not received any recent uploads for the client. If this is unexpected, then review the processes that perform uploads using that client.

  For example, if the status for GOOGLE_ADS_API is NO_RECENT_UPLOADS, that could indicate that your upload process that uses the Google Ads API stopped running recently.

• Check the successful_count and failed_count of daily_summaries and job_summaries to determine if there was a specific upload date or job that sent a large number of events that were not successfully processed.

Restrictions

Keep the following in mind when retrieving upload summaries:

• The Google Ads API only populates the offline_conversion_client_summaries field if the customer_id of the searchStream or search request is the same customer you used recently to upload conversions.

  For example, a client account that uses cross-account conversion tracking may not contain any offline_conversion_client_summaries. However, you can retrieve summaries by sending a request where the customer_id matches the customer_id of the manager account you use in uploads.

• This feature will roll out to accounts during the month of June, 2023, and will only reflect uploads from that point forward.