Method: claimSearch.list

Récupère une liste de revendications correspondant aux critères de recherche. Vous pouvez rechercher les revendications associées à un élément ou une vidéo spécifiques, ou qui correspondent à une chaîne de requête spécifiée.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
assetId

string

Le paramètre assetId spécifie l'ID d'élément YouTube de l'élément pour lequel vous récupérez les revendications.
contentType

enum (ContentType)

Le paramètre contentType spécifie le type de contenu des revendications que vous souhaitez récupérer.
createdAfter

string

Le paramètre createdAfter vous permet de limiter l'ensemble des revendications renvoyées à celles créées à la date spécifiée ou après (inclus).
createdBefore

string

Le paramètre createdBefore vous permet de limiter l'ensemble des revendications renvoyées à celles créées avant la date spécifiée (exclusivement).
inactiveReasons

string

Le paramètre inactiveReasons vous permet de spécifier le type de revendications inactives que vous souhaitez trouver en fonction des raisons pour lesquelles elles sont devenues inactives.
includeThirdPartyClaims

boolean

Utilisé avec le paramètre videoId, ce paramètre détermine s'il faut inclure ou non les revendications de tiers dans les résultats de recherche.
onBehalfOfContentOwner

string

Le paramètre onBehalfOfContentOwner identifie le propriétaire du contenu pour lequel l'utilisateur agit. Ce paramètre est destiné aux utilisateurs dont les comptes sont associés à plusieurs propriétaires de contenu.
origin

string

Le paramètre origin spécifie les origines pour lesquelles vous souhaitez trouver des revendications. Il s'agit d'une liste de valeurs d'origine séparées par une virgule.
pageToken

string

Le paramètre pageToken spécifie un jeton qui identifie une page de résultats spécifique à renvoyer. Par exemple, définissez ce paramètre sur la valeur de nextPageToken de la réponse d'API précédente pour récupérer la page suivante des résultats de recherche.
partnerUploaded

boolean

Le paramètre partnerUploaded indique si vous souhaitez filtrer vos résultats de recherche pour n'afficher que les revendications mises en ligne par des partenaires ou celles qui ne le sont pas.
q

string

Le paramètre q spécifie la chaîne de requête à utiliser pour filtrer les résultats de recherche. YouTube recherche la chaîne de requête dans les champs de revendication suivants : videoTitle, video_keywords, user_name, isrc, iswc, grid, customId et dans l'adresse e-mail du propriétaire du contenu.
referenceId

string

Le paramètre referenceId spécifie l'ID de référence YouTube de la référence pour laquelle vous récupérez les revendications.
sort

enum (Sort)

Le paramètre sort spécifie la méthode qui sera utilisée pour ordonner les ressources dans la réponse de l'API. La valeur par défaut est date. Toutefois, si la valeur du paramètre status est appealed, disputed, pending, potential ou routedForReview, les résultats seront triés par date d'expiration du délai d'examen de la réclamation.
status

enum (Status)

Le paramètre status limite vos résultats aux seules réclamations dont l'état correspond à celui spécifié.
statusModifiedAfter

string

Le paramètre statusModifiedAfter vous permet de limiter l'ensemble de résultats aux revendications dont l'état a été modifié à la date spécifiée ou après (inclus). La date spécifiée doit être le 30 juin 2016 (2016-06-30) ou une date ultérieure. Le format de la valeur du paramètre est YYYY-MM-DD.
statusModifiedBefore

string

Le paramètre statusModifiedBefore vous permet de limiter l'ensemble de résultats aux revendications dont l'état a été modifié avant la date spécifiée (non incluse). La date spécifiée doit être le 1er juillet 2016 (2016-07-01) ou une date ultérieure. Le format de la valeur du paramètre est YYYY-MM-DD.
videoId

string

Le paramètre videoId spécifie une liste d'ID de vidéos YouTube séparés par une virgule pour lesquelles vous récupérez des revendications.
isVideoShortsEligible

boolean

Le paramètre isVideoShortsEligible vous permet de restreindre l'ensemble de résultats pour n'inclure que les revendications sur des vidéos éligibles aux Shorts YouTube, ou de les exclure. Si aucune valeur n'est spécifiée, aucun filtrage ne sera effectué en fonction de l'éligibilité aux Shorts YouTube.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Liste paginée d'extraits de revendications renvoyés en réponse à un appel claimSearch.list.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "kind": string,
  "pageInfo": {
    object (PageInfo)
  },
  "items": [
    {
      object (ClaimSnippet)
    }
  ],
  "nextPageToken": string,
  "previousPageToken": string
}
Champs
kind

string

Type de réponse de l'API. Pour cette opération, la valeur est youtubePartner#claimSnippetList.
pageInfo

object (PageInfo)

L'objet pageInfo encapsule les informations de pagination pour l'ensemble de résultats.
items[]

object (ClaimSnippet)

Liste des revendications correspondant aux critères de la requête.
nextPageToken

string

Jeton pouvant être utilisé comme valeur du paramètre pageToken pour récupérer la page suivante de l'ensemble de résultats.
previousPageToken

string

Jeton pouvant être utilisé comme valeur du paramètre pageToken pour récupérer la page précédente de l'ensemble de résultats.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la OAuth 2.0 Overview.

ContentType

Énumération du type de contenu.

Enums
CONTENT_TYPE_UNSPECIFIED Valeur par défaut.
AUDIO Limitez les résultats aux revendications audio uniquement.
AUDIOVISUAL Limitez les résultats aux revendications audiovisuelles.
VISUAL Limitez les résultats aux revendications concernant uniquement des vidéos.

Trier

Ordres de tri acceptés.

Enums
SORT_UNSPECIFIED Valeur par défaut.
DATE Les ressources sont triées dans l'ordre chronologique inverse (de la plus récente à la plus ancienne) en fonction de leur date de création. Cette valeur n'est pas applicable si le paramètre status est défini sur l'une des valeurs suivantes : appealed, disputed, pending, potential ou routedForReview.
DAILY_ENGAGED_VIEWS Les ressources sont triées par ordre décroissant du nombre approximatif de vues engagées quotidiennes pour le contenu revendiqué. Cette valeur n'est pas applicable si le paramètre status est défini sur l'une des valeurs suivantes : appealed, disputed, pending, potential ou routedForReview.
LIFETIME_ENGAGED_VIEWS Les ressources sont triées par ordre décroissant du nombre approximatif de vues engagées à vie pour le contenu revendiqué. Cette valeur n'est pas applicable si le paramètre status est défini sur l'une des valeurs suivantes : appealed, disputed, pending, potential ou routedForReview.

État

Énumération de l'état de la demande.

Enums
STATUS_UNSPECIFIED Valeur par défaut.
ACTIVE Limitez les résultats aux revendications dont l'état est "Actif".
APPEALED Limitez les résultats aux revendications dont l'état est "En appel".
DISPUTED Limitez les résultats aux revendications dont l'état est "Contestée".
INACTIVE Limitez les résultats aux revendications dont l'état est "Inactif".
PENDING Limitez les résultats aux revendications dont l'état est "En attente".
POTENTIAL Limitez les résultats aux revendications dont l'état est "Potentiel".
ROUTED_FOR_REVIEW Restreignez les résultats aux revendications nécessitant un examen en fonction d'une règle de la règle de correspondance.
TAKEDOWN Limitez les résultats aux revendications dont l'état est "Supprimée".
SHORT_MATCH Limitez les résultats aux revendications pour lesquelles le segment correspondant est trop court pour que nous puissions être sûrs qu'elles doivent être effectuées.
YOUTUBE_PARTNER Limitez les résultats aux revendications concernant des vidéos mises en ligne sur une chaîne appartenant à un partenaire YT.
LOW_CONFIDENCE Restreindre les résultats aux revendications peu fiables pour diverses raisons, y compris un faible score de correspondance, un faible niveau de confiance, un nombre de vues élevé, etc.
YT_MONETIZATION_POLICY Limitez les résultats aux revendications de tiers qui sont probablement des revendications de propriétaire effectuées par le biais d'agrégateurs de musique (permettant aux créateurs de monétiser leurs contenus sans avoir à rejoindre le Programme Partenaire YouTube).
RETROACTIVE_BLOCK Limitez les résultats aux revendications à la fiabilité faible ayant entraîné le blocage de vidéos.