--- title: "POST /v23/customers/{customersId}:generateBenchmarksMetrics" method: POST path: "/v23/customers/{customersId}:generateBenchmarksMetrics" tags: ["customers"] --- # POST /v23/customers/{customersId}:generateBenchmarksMetrics `POST /v23/customers/{customersId}:generateBenchmarksMetrics` ## Request - Base URL: `https://searchads360.googleapis.com` - URL: `https://searchads360.googleapis.com/v23/customers/{customersId}:generateBenchmarksMetrics` - Auth: OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/doubleclicksearch` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/doubleclicksearch` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns YouTube advertisement metrics for the given client against industry benchmarks. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BenchmarksError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]() ## Path parameters - `customersId` string, required ## Request body - GoogleAdsSearchads360V23ServicesGenerateBenchmarksMetricsRequest: Request message for BenchmarksService.GenerateBenchmarksMetrics. - `applicationInfo` GoogleAdsSearchads360V23CommonAdditionalApplicationInfo: Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. - `applicationId` string: 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. - `applicationInstance` 'UNSPECIFIED' | 'UNKNOWN' | 'DEVELOPMENT_AND_TESTING' | 'PRODUCTION': The instance type of the application sending the request. - `benchmarksSource` GoogleAdsSearchads360V23ServicesBenchmarksSource: The source used to generate benchmarks metrics for. The ID of the source can be obtained from BenchmarksService.ListBenchmarksSources. - `industryVerticalId` string, int64: The ID of the Industry Vertical. - `currencyCode` string: Optional. The three-character ISO 4217 currency code. If unspecified, the default currency for monetary values is USD. - `customerBenchmarksGroup` string: The name of the customer being planned for. This is a user-defined value. - `dateRange` GoogleAdsSearchads360V23CommonDateRange: A date range. - `endDate` string: The end date, in yyyy-mm-dd format. This date is inclusive. - `startDate` string: The start date, in yyyy-mm-dd format. This date is inclusive. - `location` GoogleAdsSearchads360V23CommonLocationInfo: A location criterion. - `geoTargetConstant` string: The geo target constant resource name. - `productFilter` GoogleAdsSearchads360V23ServicesProductFilter: The type and list of products to aggregate benchmarks metrics over. - `marketingObjectiveList` GoogleAdsSearchads360V23ServicesProductFilterMarketingObjectiveList: The list of marketing objectives to generate benchmarks metrics for. - `marketingObjectives` string[]: Required. Marketing objectives to generate benchmarks metrics for. - `productList` GoogleAdsSearchads360V23ServicesProductFilterProductList: The list of products to generate benchmarks metrics for. - `productCodes` string[]: Required. Products to generate benchmarks metrics for. ## Response `200` Successful response - GoogleAdsSearchads360V23ServicesGenerateBenchmarksMetricsResponse: Response message for BenchmarksService.GenerateBenchmarksMetrics. - `averageBenchmarksMetrics` GoogleAdsSearchads360V23ServicesMetrics: All metrics returned against a criteria. - `averageRateMetrics` GoogleAdsSearchads360V23ServicesRateMetrics: Average rate metrics. Metrics that represent monetary values are returned in USD by default, if unspecified in the request. - `activeViewViewability` number, double: The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions). - `averageActiveViewCpm` number, double: Average cost-per-thousand viewable impressions. - `averageCpc` number, double: The average cost-per-click (CPC) is defined by the total cost of all clicks divided by the total number of clicks received. - `averageCpe` number, double: The average cost-per-engagement (CPE) is defined by the total cost of all ad engagements divided by the total number of ad engagements. - `averageCpi` number, double: The average cost-per-interaction (CPI) is defined by the total cost of all interactions divided by the total number of interactions. - `averageCpm` number, double: Average cost-per-thousand impressions (CPM). - `clickThroughRate` number, double: The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions). - `engagementRate` number, double: How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown. - `interactionRate` number, double: How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown. - `trueviewAverageCpv` number, double: The average TrueView cost-per-view (CPV) is defined by the total cost of all ad TrueView views divided by the number of TrueView views. - `trueviewViewRate` number, double: Number of completed TrueView views divided by the number of impressions. - `videoCompletionP100Rate` number, double: Percentage of impressions where the viewer watched all of your video. - `videoCompletionP25Rate` number, double: Percentage of impressions where the viewer watched 25% of your video. - `videoCompletionP50Rate` number, double: Percentage of impressions where the viewer watched 50% of your video. - `videoCompletionP75Rate` number, double: Percentage of impressions where the viewer watched 75% of your video. - `customerMetrics` GoogleAdsSearchads360V23ServicesMetrics: All metrics returned against a criteria. - `averageRateMetrics` GoogleAdsSearchads360V23ServicesRateMetrics: Average rate metrics. Metrics that represent monetary values are returned in USD by default, if unspecified in the request. - `activeViewViewability` number, double: The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions). - `averageActiveViewCpm` number, double: Average cost-per-thousand viewable impressions. - `averageCpc` number, double: The average cost-per-click (CPC) is defined by the total cost of all clicks divided by the total number of clicks received. - `averageCpe` number, double: The average cost-per-engagement (CPE) is defined by the total cost of all ad engagements divided by the total number of ad engagements. - `averageCpi` number, double: The average cost-per-interaction (CPI) is defined by the total cost of all interactions divided by the total number of interactions. - `averageCpm` number, double: Average cost-per-thousand impressions (CPM). - `clickThroughRate` number, double: The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions). - `engagementRate` number, double: How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown. - `interactionRate` number, double: How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown. - `trueviewAverageCpv` number, double: The average TrueView cost-per-view (CPV) is defined by the total cost of all ad TrueView views divided by the number of TrueView views. - `trueviewViewRate` number, double: Number of completed TrueView views divided by the number of impressions. - `videoCompletionP100Rate` number, double: Percentage of impressions where the viewer watched all of your video. - `videoCompletionP25Rate` number, double: Percentage of impressions where the viewer watched 25% of your video. - `videoCompletionP50Rate` number, double: Percentage of impressions where the viewer watched 50% of your video. - `videoCompletionP75Rate` number, double: Percentage of impressions where the viewer watched 75% of your video. --- [API](https://skmtc.dev/google/apis/searchads360.md) - [All operations](https://skmtc.dev/google/apis/searchads360/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/searchads360/revisions/4a4511f84b18?raw)