Method: customers.generateCreatorInsights

Returns insights for a collection of YouTube Creators and Channels.

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

HTTP request

POST https://googleads.googleapis.com/v19/customers/{customerId}:generateCreatorInsights

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 
{
  "customerInsightsGroup": string,
  "countryLocations": [
    {
      object (LocationInfo)
    }
  ],

  // Union field criteria can be only one of the following:
  "searchAttributes": {
    object (SearchAttributes)
  },
  "searchBrand": {
    object (SearchBrand)
  },
  "searchChannels": {
    object (YouTubeChannels)
  }
  // End of list of possible types for union field criteria.
}
Fields
customerInsightsGroup

string

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

object (LocationInfo)

Required. The countries to search that apply to the criteria.
Union field criteria. A criteria used to search for creators and creator insights. criteria can be only one of the following:
searchAttributes

object (SearchAttributes)

The attributes used to identify top creators. Data fetched is based on the list of countries specified in [countryLocations].
searchBrand

object (SearchBrand)

A brand used to search for top creators. Data fetched is based on the list of countries specified in [countryLocations].
searchChannels

object (YouTubeChannels)

YouTube Channel IDs for Creator Insights. Data fetched for channels is based on the list of countries specified in [countryLocations].

Response body

Response message for ContentCreatorInsightsService.GenerateCreatorInsights.

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

JSON representation 
{
  "creatorInsights": [
    {
      object (YouTubeCreatorInsights)
    }
  ]
}
Fields
creatorInsights[]

object (YouTubeCreatorInsights)

A collection of YouTube Creators, each containing a collection of YouTube Channels maintained by the YouTube Creator.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

SearchAttributes

The audience attributes (such as Age, Gender, Affinity, and In-Market) and creator attributes (such as creator's content topics) used to search for top creators.

JSON representation 
{
  "audienceAttributes": [
    {
      object (AudienceInsightsAttribute)
    }
  ],
  "creatorAttributes": [
    {
      object (AudienceInsightsAttribute)
    }
  ]
}
Fields
audienceAttributes[]

object (AudienceInsightsAttribute)

Optional. Audience attributes that describe an audience of viewers. This is used to search for creators whose own viewers match the input audience. Attributes ageRange, gender, userInterest, entity, category, parentalStatus, and incomeRange are supported. Attribute location is not supported.
creatorAttributes[]

object (AudienceInsightsAttribute)

Optional. Creator attributes that describe a collection of types of content. This is used to search for creators whose content matches the input creator attributes. Attribute entity tagged with [InsightsKnowledgeGraphEntityCapabilities.CREATOR_ATTRIBUTE][] is supported. Other attributes including location are not supported.

SearchBrand

The brand used to search for top creators.

JSON representation 
{
  "brandEntities": [
    {
      object (AudienceInsightsAttribute)
    }
  ],
  "includeRelatedTopics": boolean
}
Fields
brandEntities[]

object (AudienceInsightsAttribute)

Optional. One or more Knowledge Graph Entities that represent the brand for which to find insights.

YouTubeChannels

A collection of YouTube Channels.

JSON representation 
{
  "youtubeChannels": [
    {
      object (YouTubeChannelInfo)
    }
  ]
}
Fields
youtubeChannels[]

object (YouTubeChannelInfo)

Optional. The YouTube Channel IDs to fetch creator insights for.

YouTubeCreatorInsights

A YouTube creator and the insights for this creator.

JSON representation 
{
  "creatorName": string,
  "creatorChannels": [
    {
      object (YouTubeChannelInsights)
    }
  ]
}
Fields
creatorName

string

The name of the creator.
creatorChannels[]

object (YouTubeChannelInsights)

The list of YouTube Channels

YouTubeChannelInsights

YouTube Channel insights, and its metadata (such as channel name and channel ID), returned for a creator insights response.

JSON representation 
{
  "displayName": string,
  "youtubeChannel": {
    object (YouTubeChannelInfo)
  },
  "channelUrl": string,
  "channelDescription": string,
  "channelMetrics": {
    object (YouTubeMetrics)
  },
  "channelAudienceAttributes": [
    {
      object (AudienceInsightsAttributeMetadata)
    }
  ],
  "channelAttributes": [
    {
      object (AudienceInsightsAttributeMetadata)
    }
  ],
  "topVideos": [
    {
      object (AudienceInsightsAttributeMetadata)
    }
  ],
  "channelType": string
}
Fields
displayName

string

The name of the YouTube Channel.
youtubeChannel

object (YouTubeChannelInfo)

The YouTube Channel ID.
channelUrl

string

URL for the channel in the form of https://www.youtube.com/channel/{channelId}.
channelDescription

string

Description of the channel.
channelMetrics

object (YouTubeMetrics)

The metrics for a YouTube Channel.
channelAudienceAttributes[]

object (AudienceInsightsAttributeMetadata)

The types of audiences and demographics linked to the channel's main audience. Audiences and demographics have a breakdown of subscriber share across dimensions of the same value, such as Age Range, Gender, and User Interest.
channelAttributes[]

object (AudienceInsightsAttributeMetadata)

The attributes associated with the content made by a channel.
topVideos[]

object (AudienceInsightsAttributeMetadata)

The top 10 videos for the channel.
channelType

string

Metadata string associated with the type of channel.

YouTubeMetrics

YouTube Channel metrics.

JSON representation 
{
  "subscriberCount": string,
  "viewsCount": string,
  "videoCount": string,
  "isActiveShortsCreator": boolean
}
Fields
subscriberCount

string (int64 format)

The number of subscribers.
viewsCount

string (int64 format)

The total number of views.
videoCount

string (int64 format)

The total number of videos.
isActiveShortsCreator

boolean

When true, this channel has published a shorts video in the last 90 days.