Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Method: customers.generateInsightsFinderReport

Creates a saved report that can be viewed in the Insights Finder tool.

List of thrown errors: AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError

HTTP request

POST https://googleads.googleapis.com/v13/customers/{customerId}:generateInsightsFinderReport

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "baselineAudience": {
    object (BasicInsightsAudience)
  },
  "specificAudience": {
    object (BasicInsightsAudience)
  },
  "customerInsightsGroup": string
}
Fields
baselineAudience

object (BasicInsightsAudience)

Required. A baseline audience for this report, typically all people in a region.
specificAudience

object (BasicInsightsAudience)

Required. The specific audience of interest for this report. The insights in the report will be based on attributes more prevalent in this audience than in the report's baseline audience.
customerInsightsGroup

string

The name of the customer being planned for. This is a user-defined value.

Response body

If successful, the response body contains data with the following structure:

The response message for AudienceInsightsService.GenerateInsightsFinderReport, containing the shareable URL for the report.

JSON representation 
{
  "savedReportUrl": string
}
Fields
savedReportUrl

string

An HTTPS URL providing a deep link into the Insights Finder UI with the report inputs filled in according to the request.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

BasicInsightsAudience

A description of an audience used for requesting insights.

JSON representation 
{
  "countryLocation": [
    {
      object (LocationInfo)
    }
  ],
  "subCountryLocations": [
    {
      object (LocationInfo)
    }
  ],
  "gender": {
    object (GenderInfo)
  },
  "ageRanges": [
    {
      object (AgeRangeInfo)
    }
  ],
  "userInterests": [
    {
      object (UserInterestInfo)
    }
  ],
  "topics": [
    {
      object (AudienceInsightsTopic)
    }
  ]
}
Fields
countryLocation[]

object (LocationInfo)

Required. The countries for this audience.
subCountryLocations[]

object (LocationInfo)

Sub-country geographic location attributes. If present, each of these must be contained in one of the countries in this audience.
gender

object (GenderInfo)

Gender for the audience. If absent, the audience does not restrict by gender.
ageRanges[]

object (AgeRangeInfo)

Age ranges for the audience. If absent, the audience represents all people over 18 that match the other attributes.
userInterests[]

object (UserInterestInfo)

User interests defining this audience. Affinity and In-Market audiences are supported.
topics[]

object (AudienceInsightsTopic)

Topics, represented by Knowledge Graph entities and/or Product & Service categories, that this audience is interested in.

AudienceInsightsTopic

An entity or category representing a topic that defines an audience.

JSON representation 
{

  // Union field topic can be only one of the following:
  "entity": {
    object (AudienceInsightsEntity)
  },
  "category": {
    object (AudienceInsightsCategory)
  }
  // End of list of possible types for union field topic.
}
Fields
Union field topic. An entity or category attribute. topic can be only one of the following:
entity

object (AudienceInsightsEntity)

A Knowledge Graph entity
category

object (AudienceInsightsCategory)

A Product & Service category