Method: assetSearch.list

Busca elementos a partir de los metadatos de elementos. Este método puede recuperar todos los elementos o solo aquellos que pertenecen al propietario del contenido. Este método imita la funcionalidad de la función de búsqueda avanzada en la página Elementos en CMS.

Solicitud HTTP

GET https://youtubepartner.googleapis.com/youtube/partner/v1/assetSearch

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
createdAfter

string

El parámetro createdAfter restringe el conjunto de recursos devueltos a aquellos que se crearon originalmente en la fecha y hora especificadas o después de ellas. Por ejemplo: 2015-01-29T23:00:00Z.

createdBefore

string

El parámetro createdBefore restringe el conjunto de recursos que se muestran a aquellos que se crearon originalmente en la fecha y hora especificadas o antes. Por ejemplo: 2015-01-29T23:00:00Z.

hasConflicts

boolean

El parámetro hasConflicts te permite recuperar solo los activos que tienen conflictos de propiedad. El único valor válido es true. Establecer el valor del parámetro en false no afecta los resultados.

includeAnyProvidedlabel

boolean

Si el parámetro includeAnyProvidedlabel se establece como verdadero, se buscarán los activos que contengan cualquiera de las etiquetas proporcionadas; de lo contrario, se buscarán los activos que contengan todas las etiquetas proporcionadas.

isrcs

string

Es una lista separada por comas de hasta 50 ISRC. Si especificas un valor para este parámetro, el servidor de la API ignorará cualquier valor establecido para los siguientes parámetros: q, includeAnyProvidedLabel, hasConflicts, labels, metadataSearchFields, sort y type.

labels

string

El parámetro labels especifica los activos con ciertas etiquetas de activos que deseas recuperar. El valor del parámetro es una lista separada por comas de etiquetas de recursos.

metadataSearchFields

string

El parámetro metadataSearchField especifica los campos de metadatos por los que se realizará la búsqueda. Es una lista separada por comas de pares de campos y valores de metadatos conectados por dos puntos(:). Por ejemplo: customId:my_custom_id,artist:Dandexx

onBehalfOfContentOwner

string

El parámetro onBehalfOfContentOwner identifica al propietario del contenido en nombre del cual actúa el usuario. Este parámetro admite a los usuarios cuyas cuentas están asociadas con varios propietarios de contenido.

ownershipRestriction

enum (OwnershipRestriction)

El parámetro ownershipRestriction especifica la opción de filtrado por propiedad para la búsqueda. De forma predeterminada, la búsqueda solo se realiza en los recursos que pertenecen al usuario autenticado actualmente.

pageToken

string

El parámetro pageToken especifica un token que identifica una página de resultados en particular que se devolverá. Configura este parámetro en el valor de nextPageToken de la respuesta anterior de la API para recuperar la siguiente página de resultados de la búsqueda.

q

string

YouTube busca en los campos id, type y customId de todos los recursos, así como en muchos otros campos de metadatos, como actor, album, director, isrc y tmsId, que varían según los diferentes tipos de recursos (películas, videos musicales, etc.).

sort

enum (Sort)

El parámetro sort especifica cómo se deben ordenar los resultados de la búsqueda. Ten en cuenta que los resultados siempre se ordenan de forma descendente.

type

string

El parámetro type especifica los tipos de activos que deseas recuperar. El valor del parámetro es una lista separada por comas de tipos de recursos.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

En esta respuesta, se muestra una lista de recursos de YouTube que coinciden con una búsqueda. Cada elemento de la lista contiene los metadatos de un activo.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON
{
  "kind": string,
  "pageInfo": {
    object (PageInfo)
  },
  "items": [
    {
      object (AssetSnippet)
    }
  ],
  "nextPageToken": string
}
Campos
kind

string

Es el tipo de respuesta de la API. Para esta operación, el valor es youtubePartner#assetSnippetList.

pageInfo

object (PageInfo)

El objeto pageInfo encapsula la información de paginación del conjunto de resultados.

items[]

object (AssetSnippet)

Es una lista de recursos de activos que coinciden con los criterios de la solicitud.

nextPageToken

string

Es el token que se puede usar como valor del parámetro pageToken para recuperar la siguiente página de resultados.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta OAuth 2.0 Overview.

OwnershipRestriction

Es un enum de restricción de propiedad.

Enums
OWNERSHIP_RESTRICTION_UNSPECIFIED Valor predeterminado
MINE Busca recursos que pertenezcan al usuario actual y que coincidan con la búsqueda. Este es el comportamiento predeterminado.
NONE Encuentra todos los activos que coincidan con la búsqueda, independientemente del propietario.

Ordenar

Es un enum de los órdenes de clasificación admitidos en la solicitud de lista de búsqueda de recursos.

Enums
SORT_UNSPECIFIED Valor predeterminado
CLAIMS Ordenar por la cantidad de reclamos de cada activo
TIME Ordena por la hora de modificación de cada recurso. Este es el valor predeterminado.
DAILY_ENGAGED_VIEWS Ordena los recursos según las vistas diarias aproximadas de participación.