Method: claimSearch.list

Recupera una lista de reclamos que coinciden con los criterios de búsqueda. Puedes buscar reclamos asociados a un elemento o video específico, o que coincidan con una cadena de consulta especificada.

Solicitud HTTP

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

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

Parámetros de consulta

Parámetros
assetId

string

El parámetro assetId especifica el ID del activo de YouTube del activo que recuperas los reclamos.
contentType

enum (ContentType)

El parámetro contentType especifica el tipo de contenido de reclamaciones que deseas recuperar.
createdAfter

string

El parámetro createdAfter te permite restringir el conjunto de reclamaciones que se muestran a las que se crearon a partir de la fecha especificada (incluida).
createdBefore

string

El parámetro createdBefore te permite restringir el conjunto de reclamaciones que se muestran a las que se crearon antes de la fecha especificada (excluido).
inactiveReasons

string

El parámetro inactiveReasons te permite especificar qué tipo de reclamos inactivos deseas encontrar según los motivos por los que se volvieron inactivos.
includeThirdPartyClaims

boolean

Si se usa junto con el parámetro videoId, este parámetro determina si se deben incluir o no reclamos de terceros en los resultados de la búsqueda.
onBehalfOfContentOwner

string

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

string

El parámetro origin especifica los orígenes de los que quieres buscar reclamos. Es una lista de valores de origen separados por comas.
pageToken

string

El parámetro pageToken especifica un token que identifica una página particular de resultados para mostrar. Por ejemplo, establece este parámetro en el valor del valor nextPageToken de la respuesta de la API anterior para recuperar la siguiente página de resultados de la búsqueda.
partnerUploaded

boolean

El parámetro partnerUploaded especifica si deseas filtrar los resultados de la búsqueda para mostrar solo reclamos subidos por socios o reclamos no subidos por socios.
q

string

El parámetro q especifica la cadena de consulta que se usará para filtrar los resultados de la búsqueda. YouTube busca la cadena de consulta en los siguientes campos de reclamo: videoTitle, video_keywords, user_name, isrc, iswc, grid, customId y en la dirección de correo electrónico del propietario del contenido.
referenceId

string

El parámetro referenceId especifica el ID de referencia de YouTube de la referencia para la que se recuperan los reclamos.
sort

enum (Sort)

El parámetro sort especifica el método que se usará para ordenar los recursos en la respuesta de la API. El valor predeterminado es date. Sin embargo, si el valor del parámetro status es appealed, disputed, pending, potential o routedForReview, los resultados se ordenarán según el momento en que venza el período de revisión de reclamos.
status

enum (Status)

El parámetro status restringe tus resultados a solo los reclamos en el estado especificado.
statusModifiedAfter

string

El parámetro statusModifiedAfter te permite restringir el conjunto de resultados para que solo incluya reclamos cuyo estado se haya modificado en la fecha especificada o después de ella. La fecha especificada debe ser a partir del 30 de junio de 2016 (30 de junio de 2016). El formato del valor del parámetro es YYYY-MM-DD.
statusModifiedBefore

string

El parámetro statusModifiedBefore te permite restringir el conjunto de resultados para que solo incluya reclamos cuyo estado se haya modificado antes de la fecha especificada (exclusivo). La fecha especificada debe ser a partir del 1 de julio de 2016 (1 de julio de 2016). El formato del valor del parámetro es YYYY-MM-DD.
videoId

string

El parámetro videoId especifica una lista separada por comas de ID de videos de YouTube para los que se recuperan reclamos.
isVideoShortsEligible

boolean

El parámetro isVideoShortsEligible te permite restringir el conjunto de resultados para que solo incluya reclamos de videos aptos para YouTube Shorts, o bien para excluirlos. Si no se especifica, no se aplicará ningún filtro según la elegibilidad de YouTube Shorts.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Una lista paginada de fragmentos de reclamos que se muestran en respuesta a una llamada a claimSearch.list.

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 (ClaimSnippet)
    }
  ],
  "nextPageToken": string,
  "previousPageToken": string
}
Campos
kind

string

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

object (PageInfo)

El objeto pageInfo encapsula información de paginación para el conjunto de resultados.
items[]

object (ClaimSnippet)

Una lista de reclamos que coinciden con los criterios de la solicitud.
nextPageToken

string

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

string

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

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.

ContentType

Es una enumeración del tipo de contenido.

Enumeradores
CONTENT_TYPE_UNSPECIFIED Valor predeterminado
AUDIO Restringir los resultados a reclamos solo de audio
AUDIOVISUAL Restringe los resultados a los reclamos audiovisuales.
VISUAL Restringir los resultados a reclamos solo de video

Ordenar

Órdenes de clasificación admitidos

Enumeradores
SORT_UNSPECIFIED Valor predeterminado
DATE Los recursos se ordenan en forma cronológica inversa (de más recientes a más antiguos) según las fechas en las que se crearon. Este valor no se aplica si el parámetro status se establece en cualquiera de los siguientes valores: appealed, disputed, pending, potential o routedForReview.
VIEW_COUNT Los recursos se ordenan de mayor a menor cantidad de vistas para el contenido reclamado. Este valor no se aplica si el parámetro status se establece en cualquiera de los siguientes valores: appealed, disputed, pending, potential o routedForReview.

Estado

Enumeración del estado del reclamo.

Enumeradores
STATUS_UNSPECIFIED Valor predeterminado
ACTIVE Restringir los resultados a los reclamos con estado activo.
APPEALED Restringe los resultados a los reclamos con estado de apelación.
DISPUTED Restringe los resultados a los reclamos con estado de impugnación.
INACTIVE Restringe los resultados a los reclamos con estado inactivo.
PENDING Restringe los resultados a los reclamos con estado pendiente.
POTENTIAL Restringe los resultados a las afirmaciones con estado potencial.
ROUTED_FOR_REVIEW Restringe los resultados a los reclamos que deban revisarse según una regla de política de coincidencias.
TAKEDOWN Restringe los resultados a los reclamos con estado de eliminación.
SHORT_MATCH Restringe los resultados a los reclamos en los que el segmento coincidente sea demasiado corto como para tener la certeza de que debe crearse.
YOUTUBE_PARTNER Restringe los resultados a los reclamos sobre videos que se subieron a un canal que pertenece a un socio de YouTube.
LOW_CONFIDENCE Restringe los resultados a los reclamos poco confiables por varios motivos, como una puntuación de coincidencia baja, una puntuación de confianza baja, un recuento de vistas alto, etcétera.
YT_MONETIZATION_POLICY Restringe los resultados a los reclamos de terceros que se sospeche que son reclamos propios que se realizan mediante agregadores de música. Esto permite que los creadores moneticen contenido sin tener que participar en el YPP.
RETROACTIVE_BLOCK Restringir los resultados a reclamos poco confiables realizados como parte del bloqueo heredado