Method: spreadsheetTemplate.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of spreadsheet templates for a content owner.
HTTP request
GET https://youtubepartner.googleapis.com/youtube/partner/v1/spreadsheetTemplate
The URL uses gRPC Transcoding
syntax.
Query parameters
Parameters |
locale
|
string
The locale
parameter identifies the desired language for templates in the API response. The value is a string that contains a BCP-47 language code. The default value is en
.
|
onBehalfOfContentOwner
|
string
The onBehalfOfContentOwner
parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.
|
Request body
The request body must be empty.
Response body
A list of spreadsheet templates associated with a content owner.
If successful, the response body contains data with the following structure:
Fields |
status
|
string
The status of the API response.
|
kind
|
string
The type of the API response. For this operation, the value is youtubePartner#spreadsheetTemplateList
.
|
items[]
|
object ( SpreadsheetTemplate
)
A list of spreadsheet templates ( youtubePartner#spreadsheetTemplate
) resources that match the request criteria.
|
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/youtubepartner
For more information, see the OAuth 2.0 Overview
.
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eThis API endpoint retrieves a list of spreadsheet templates for a specified content owner via a GET request to \u003ccode\u003ehttps://youtubepartner.googleapis.com/youtube/partner/v1/spreadsheetTemplate\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe API request supports optional query parameters, \u003ccode\u003elocale\u003c/code\u003e to specify the language and \u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e to identify the content owner, and the request body should be empty.\u003c/p\u003e\n"],["\u003cp\u003eThe successful response body will be in JSON format with fields including \u003ccode\u003estatus\u003c/code\u003e, \u003ccode\u003ekind\u003c/code\u003e which is \u003ccode\u003eyoutubePartner#spreadsheetTemplateList\u003c/code\u003e, and an \u003ccode\u003eitems\u003c/code\u003e array containing the spreadsheet templates.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization to use this API requires the \u003ccode\u003ehttps://www.googleapis.com/auth/youtubepartner\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document details how to retrieve spreadsheet templates for a content owner using the YouTube Partner API. The `GET` request to `spreadsheetTemplate` requires specifying the `locale` and `onBehalfOfContentOwner` in the query parameters and an empty request body. The response, represented in JSON, includes the `status`, `kind`, and a list of `items` which are spreadsheet templates. Authorization requires the `https://www.googleapis.com/auth/youtubepartner` OAuth scope.\n"],null,["# Method: spreadsheetTemplate.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SpreadsheetTemplateListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a list of spreadsheet templates for a content owner.\n\n### HTTP request\n\n`GET https://youtubepartner.googleapis.com/youtube/partner/v1/spreadsheetTemplate`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `locale` | `string` The `locale` parameter identifies the desired language for templates in the API response. The value is a string that contains a BCP-47 language code. The default value is `en`. |\n| `onBehalfOfContentOwner` | `string` The `onBehalfOfContentOwner` parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA list of spreadsheet templates associated with a content owner.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"status\": string, \"kind\": string, \"items\": [ { object (/youtube/partner/reference/rest/v1/spreadsheetTemplate#SpreadsheetTemplate) } ] } ``` |\n\n| Fields ||\n|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `status` | `string` The status of the API response. |\n| `kind` | `string` The type of the API response. For this operation, the value is `youtubePartner#spreadsheetTemplateList`. |\n| `items[]` | `object (`[SpreadsheetTemplate](/youtube/partner/reference/rest/v1/spreadsheetTemplate#SpreadsheetTemplate)`)` A list of spreadsheet templates (`youtubePartner#spreadsheetTemplate`) resources that match the request criteria. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/youtubepartner`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]