GuideCategories: list

Nota: questo è un annuncio relativo al ritiro.

La risorsa guideCategories e il metodo guideCategories.list sono stati entrambi ritirati a partire dal 9 settembre 2020.

Restituisce un elenco di categorie che è possibile associare ai canali YouTube.

Impatto della quota: una chiamata a questo metodo ha un costo della quota di 1 unità.

Richiesta

Richiesta HTTP

GET https://www.googleapis.com/youtube/v3/guideCategories

Parametri

La tabella seguente elenca i parametri supportati da questa query. Tutti i parametri elencati sono parametri di query.

Parametri
Parametri obbligatori
part string
Il parametro part specifica le proprietà della risorsa guideCategory che saranno incluse nella risposta dell'API. Imposta il valore del parametro su snippet.
Filtri (specificare esattamente uno dei seguenti parametri)
id string
Il parametro id specifica un elenco separato da virgole degli ID delle categorie di canali YouTube per le risorse recuperate. In una risorsa guideCategory, la proprietà id specifica l'ID categoria del canale YouTube.
regionCode string
Il parametro regionCode indica all'API di restituire l'elenco delle categorie della guida disponibili nel paese specificato. Il valore del parametro è un codice paese ISO 3166-1 alpha-2.
Parametri facoltativi
hl string
Il parametro hl consente di specificare la lingua che verrà utilizzata per i valori di testo nella risposta dell'API. Il valore predefinito è en-US.

Corpo della richiesta

Non fornire il corpo della richiesta quando chiami questo metodo.

Risposta

Se l'esito è positivo, questo metodo restituisce un corpo della risposta con la seguente struttura:

{
  "kind": "youtube#guideCategoryListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    guideCategory resource
  ]
}

Proprietà

La tabella seguente definisce le proprietà visualizzate in questa risorsa:

Proprietà
kind string
Identifica il tipo di risorsa API. Il valore sarà youtube#guideCategoryListResponse.
etag etag
L'Etag di questa risorsa.
nextPageToken string
Il token che può essere utilizzato come valore del parametro pageToken per recuperare la pagina successiva nel set di risultati.
prevPageToken string
Il token che può essere utilizzato come valore del parametro pageToken per recuperare la pagina precedente nel set di risultati.
pageInfo object
L'oggetto pageInfo incapsula le informazioni sul paging per il set di risultati.
pageInfo.totalResults integer
Il numero totale di risultati nel set di risultati.
pageInfo.resultsPerPage integer
Il numero di risultati inclusi nella risposta dell'API.
items[] list
Un elenco di categorie che è possibile associare ai canali YouTube. In questa mappa, l'ID categoria è la chiave della mappa e il suo valore è la risorsa guideCategory corrispondente.

Errori

La tabella seguente identifica i messaggi di errore che l'API potrebbe restituire in risposta a una chiamata a questo metodo. Per ulteriori dettagli, consulta la documentazione relativa ai messaggi di errore.

Tipo di errore Dettagli errore Descrizione
notFound (404) notFound Impossibile trovare la categoria della guida identificata dal parametro id. Utilizza il metodo guideCategories.list per recuperare un elenco di valori validi.

Prova.

Usa APIs Explorer per chiamare questa API e visualizzare la richiesta e la risposta dell'API.