GoogleAdsGoogleadsV25Services__GenerateCreatorInsightsRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/google-ads/json-schema/google-ads-google-ads-googleads-v25-services-generate-creator-insights-request-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__GenerateCreatorInsightsRequest",
  "description": "Request message for ContentCreatorInsightsService.GenerateCreatorInsights.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-customers-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__GenerateCreatorInsightsRequest",
  "type": "object",
  "properties": {
    "countryLocations": {
      "description": "Required. The countries to search that apply to the criteria.",
      "items": {
        "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__LocationInfo"
      },
      "type": "array"
    },
    "searchTopics": {
      "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__SearchTopics",
      "description": "Search for relevant creators who make content about the specified topics. Data fetched is based on the country specified in country_locations. Note: This option allows searching for one country only."
    },
    "searchAttributes": {
      "description": "The attributes used to identify top creators. Data fetched is based on the list of countries or sub-country locations specified in country_locations or sub_country_locations.",
      "$ref": "#/$defs/GoogleAdsGoogleadsV25Services_GenerateCreatorInsightsRequest_SearchAttributes"
    },
    "supplementalData": {
      "description": "Optional. Optional features to include in the response. By default, only core insight data is returned. Including supplemental data here will populate additional fields in the response.",
      "items": {
        "type": "string",
        "x-enumDescriptions": [
          "Not specified.",
          "The value is unknown in this version.",
          "Populate local creator data in ContentCreatorInsightsService.GenerateTrendingInsights and ContentCreatorInsightsService.GenerateCreatorInsights. This is only available when requesting trending or creator insights for a content or creator topic. These topics are Knowledge Graph entities tagged with CONTENT_TRENDING_INSIGHTS or CREATOR_TOPIC_INSIGHTS. Local creator discovery is not supported when GenerateCreatorInsightsRequest.sub_country_locations or GenerateTrendingInsightsRequest.sub_country_locations is set. Use AudienceInsightsService.ListAudienceInsightsAttributes to get the list of supported Knowledge Graph entities."
        ],
        "enum": [
          "UNSPECIFIED",
          "UNKNOWN",
          "LOCAL_CREATOR_DATA"
        ]
      },
      "type": "array"
    },
    "searchChannels": {
      "description": "YouTube Channel IDs for Creator Insights. Data fetched for channels is based on the list of countries specified in country_locations.",
      "$ref": "#/$defs/GoogleAdsGoogleadsV25Services_GenerateCreatorInsightsRequest_YouTubeChannels"
    },
    "subCountryLocations": {
      "description": "The sub-country geographic locations to search that apply to the criteria. Only supported for SearchAttributes criteria.",
      "items": {
        "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__LocationInfo"
      },
      "type": "array"
    },
    "customerInsightsGroup": {
      "description": "Required. The name of the customer being planned for. This is a user-defined value.",
      "type": "string"
    },
    "insightsApplicationInfo": {
      "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__AdditionalApplicationInfo",
      "description": "Optional. Additional information on the application issuing the request."
    }
  },
  "$defs": {
    "GoogleAdsGoogleadsV25Common__AdditionalApplicationInfo": {
      "description": "Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs.",
      "type": "object",
      "properties": {
        "applicationId": {
          "description": "The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated.",
          "type": "string"
        },
        "applicationInstance": {
          "description": "The instance type of the application sending the request.",
          "type": "string",
          "x-enumDescriptions": [
            "Not specified.",
            "The value is unknown in this version.",
            "The instance is for development and testing purposes.",
            "The instance is for production purposes."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "DEVELOPMENT_AND_TESTING",
            "PRODUCTION"
          ]
        }
      }
    },
    "GoogleAdsGoogleadsV25Common__AgeRangeInfo": {
      "description": "An age range criterion.",
      "type": "object",
      "properties": {
        "type": {
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "Between 18 and 24 years old.",
            "Between 25 and 34 years old.",
            "Between 35 and 44 years old.",
            "Between 45 and 54 years old.",
            "Between 55 and 64 years old.",
            "65 years old and beyond.",
            "Undetermined age range."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "AGE_RANGE_18_24",
            "AGE_RANGE_25_34",
            "AGE_RANGE_35_44",
            "AGE_RANGE_45_54",
            "AGE_RANGE_55_64",
            "AGE_RANGE_65_UP",
            "AGE_RANGE_UNDETERMINED"
          ],
          "type": "string",
          "description": "Type of the age range."
        }
      }
    },
    "GoogleAdsGoogleadsV25Common__AudienceInsightsAttribute": {
      "type": "object",
      "properties": {
        "category": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__AudienceInsightsCategory",
          "description": "An audience attribute defined by interest in a Product & Service category."
        },
        "incomeRange": {
          "description": "A household income percentile range.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__IncomeRangeInfo"
        },
        "entity": {
          "description": "An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__AudienceInsightsEntity"
        },
        "youtubeChannel": {
          "description": "A YouTube channel.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__YouTubeChannelInfo"
        },
        "userInterest": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__UserInterestInfo",
          "description": "An Affinity or In-Market audience."
        },
        "parentalStatus": {
          "description": "A Parental Status value (parent, or not a parent).",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__ParentalStatusInfo"
        },
        "location": {
          "description": "An audience attribute defined by a geographic location.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__LocationInfo"
        },
        "lineup": {
          "description": "A YouTube Lineup.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__AudienceInsightsLineup"
        },
        "userList": {
          "description": "A User List.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__UserListInfo"
        },
        "youtubeVideo": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__YouTubeVideoInfo",
          "description": "A YouTube video."
        },
        "device": {
          "description": "A device type. (Mobile, Desktop, Tablet)",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__DeviceInfo"
        },
        "ageRange": {
          "description": "An audience attribute defined by an age range.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__AgeRangeInfo"
        },
        "gender": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__GenderInfo",
          "description": "An audience attribute defined by a gender."
        }
      },
      "description": "An audience attribute that can be used to request insights about the audience. Valid inputs for these fields are available from AudienceInsightsService.ListAudienceInsightsAttributes."
    },
    "GoogleAdsGoogleadsV25Common__AudienceInsightsCategory": {
      "description": "A Product and Service category.",
      "type": "object",
      "properties": {
        "categoryId": {
          "type": "string",
          "description": "Required. The criterion ID of the category."
        }
      }
    },
    "GoogleAdsGoogleadsV25Common__AudienceInsightsEntity": {
      "type": "object",
      "properties": {
        "knowledgeGraphMachineId": {
          "type": "string",
          "description": "Required. The machine ID (mid) of the Knowledge Graph entity."
        }
      },
      "description": "A Knowledge Graph entity, represented by its machine id."
    },
    "GoogleAdsGoogleadsV25Common__AudienceInsightsLineup": {
      "description": "A YouTube Lineup.",
      "type": "object",
      "properties": {
        "lineupId": {
          "description": "Required. The numeric ID of the lineup.",
          "type": "string"
        }
      }
    },
    "GoogleAdsGoogleadsV25Common__DeviceInfo": {
      "description": "A device criterion.",
      "type": "object",
      "properties": {
        "type": {
          "x-enumDescriptions": [
            "Not specified.",
            "The value is unknown in this version.",
            "Mobile devices with full browsers.",
            "Tablets with full browsers.",
            "Computers.",
            "Smart TVs and game consoles.",
            "Other device types."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "MOBILE",
            "TABLET",
            "DESKTOP",
            "CONNECTED_TV",
            "OTHER"
          ],
          "description": "Type of the device.",
          "type": "string"
        }
      }
    },
    "GoogleAdsGoogleadsV25Common__GenderInfo": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Type of the gender.",
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "Male.",
            "Female.",
            "Undetermined gender."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "MALE",
            "FEMALE",
            "UNDETERMINED"
          ]
        }
      },
      "description": "A gender criterion."
    },
    "GoogleAdsGoogleadsV25Common__IncomeRangeInfo": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Type of the income range.",
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "0%-50%.",
            "50% to 60%.",
            "60% to 70%.",
            "70% to 80%.",
            "80% to 90%.",
            "Greater than 90%.",
            "Undetermined income range."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "INCOME_RANGE_0_50",
            "INCOME_RANGE_50_60",
            "INCOME_RANGE_60_70",
            "INCOME_RANGE_70_80",
            "INCOME_RANGE_80_90",
            "INCOME_RANGE_90_UP",
            "INCOME_RANGE_UNDETERMINED"
          ]
        }
      },
      "description": "An income range criterion."
    },
    "GoogleAdsGoogleadsV25Common__InsightsAudienceAttributeGroup": {
      "description": "A list of AudienceInsightsAttributes.",
      "type": "object",
      "properties": {
        "attributes": {
          "type": "array",
          "description": "Required. A collection of audience attributes combined with logical OR. Attributes need not all be the same dimension. Only Knowledge Graph entities, Product & Service Categories, and user interests are supported in this context.",
          "items": {
            "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__AudienceInsightsAttribute"
          }
        }
      }
    },
    "GoogleAdsGoogleadsV25Common__LocationInfo": {
      "type": "object",
      "properties": {
        "geoTargetConstant": {
          "type": "string",
          "description": "The geo target constant resource name."
        }
      },
      "description": "A location criterion."
    },
    "GoogleAdsGoogleadsV25Common__ParentalStatusInfo": {
      "type": "object",
      "properties": {
        "type": {
          "description": "Type of the parental status.",
          "type": "string",
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "Parent.",
            "Not a parent.",
            "Undetermined parental status."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "PARENT",
            "NOT_A_PARENT",
            "UNDETERMINED"
          ]
        }
      },
      "description": "A parental status criterion."
    },
    "GoogleAdsGoogleadsV25Common__UserInterestInfo": {
      "description": "Represents a particular interest-based topic to be targeted.",
      "type": "object",
      "properties": {
        "userInterestCategory": {
          "type": "string",
          "description": "The UserInterest resource name."
        }
      }
    },
    "GoogleAdsGoogleadsV25Common__UserListInfo": {
      "type": "object",
      "properties": {
        "userList": {
          "type": "string",
          "description": "The User List resource name."
        }
      },
      "description": "A User List criterion. Represents a user list that is defined by the advertiser to be targeted."
    },
    "GoogleAdsGoogleadsV25Common__YouTubeChannelInfo": {
      "type": "object",
      "properties": {
        "channelId": {
          "type": "string",
          "description": "The YouTube uploader channel id or the channel code of a YouTube channel."
        }
      },
      "description": "A YouTube Channel criterion."
    },
    "GoogleAdsGoogleadsV25Common__YouTubeVideoInfo": {
      "description": "A YouTube Video criterion.",
      "type": "object",
      "properties": {
        "videoId": {
          "type": "string",
          "description": "YouTube video id as it appears on the YouTube watch page."
        }
      }
    },
    "GoogleAdsGoogleadsV25Services_GenerateCreatorInsightsRequest_SearchAttributes": {
      "description": "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. The returned creators are sorted based on likelihood that your audience watches the creator, relative to the general population (most likely is returned first).",
      "type": "object",
      "properties": {
        "audienceAttributes": {
          "type": "array",
          "description": "Optional. Audience attributes that describe an audience of viewers. This is used to search for creators whose own viewers match the input audience. Attributes age_range, gender, user_interest, entity, category, device, parental_status, and income_range are supported. Attribute location is not supported. Attributes user_interest, entity, and category can only be set in audience_attributes when audience_combinations is unused.",
          "items": {
            "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__AudienceInsightsAttribute"
          }
        },
        "audienceCombinations": {
          "type": "array",
          "description": "Optional. A list of audience attribute groups consisting of one or more Knowledge Graph entities, Product & Service Categories and user interests that describes an audience. The groups have a logical AND-of-ORs structure: 1. Attributes within each InsightsAudienceAttributeGroup are combined with OR. 2. The groups themselves are combined together with AND. For example, an audience (Interest A OR Interest B) AND (Entity C) is represented using two groups. The first group contains the two interests and the second group contains the entity. This field cannot be set if any Knowledge Graph entities, Product & Service Categories, or user interests are specified in audience_attributes.",
          "items": {
            "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__InsightsAudienceAttributeGroup"
          }
        },
        "creatorAttributes": {
          "description": "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. Only Knowledge Graph Entities tagged with CREATOR_ATTRIBUTE are supported. Use AudienceInsightsService.ListAudienceInsightsAttributes to get the list of supported entities. Other attributes including location are not supported.",
          "items": {
            "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__AudienceInsightsAttribute"
          },
          "type": "array"
        }
      }
    },
    "GoogleAdsGoogleadsV25Services_GenerateCreatorInsightsRequest_YouTubeChannels": {
      "description": "A collection of YouTube Channels.",
      "type": "object",
      "properties": {
        "youtubeChannels": {
          "type": "array",
          "description": "Optional. The YouTube Channel IDs to fetch creator insights for.",
          "items": {
            "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__YouTubeChannelInfo"
          }
        }
      }
    },
    "GoogleAdsGoogleadsV25Services__SearchTopics": {
      "type": "object",
      "properties": {
        "entities": {
          "type": "array",
          "description": "Required. A list of knowledge graph entities to retrieve creator and trend information for. Supported entities are tagged with CONTENT_TRENDING_INSIGHTS or CREATOR_TOPIC_INSIGHTS. Use AudienceInsightsService.ListAudienceInsightsAttributes to get the list of supported entities.",
          "items": {
            "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__AudienceInsightsEntity"
          }
        }
      },
      "description": "A collection of content topics to return creator and trend information for."
    }
  }
}