REST Resource: claimHistory

    • claimHistory resources detail the lifecycle of a claim, including events like creation, updates, disputes, and closure.

    • Each claimEvent resource represents a specific occurrence in a claim's history, including details like the event time, type, reason, and source.

    • The Source resource specifies information related to the origin of a claimEvent , including the event source type, user email, and content owner ID.

    • The TypeDetails resource provides specifics about the event's type, such as the dispute reason, update status, dispute notes, or appeal explanations.

    • The get method within the claimHistory allows retrieving the full history for a specified claim.

    Resource: ClaimHistory

    A claimHistory resource identifies the set of events that describe a claim's life cycle, such as the claim being created, updated, disputed, or closed.

    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "event" 
 : 
 [ 
 { 
 object (  ClaimEvent 
 
) 
 } 
 ] 
 , 
 "id" 
 : 
 string 
 , 
 "uploaderChannelId" 
 : 
 string 
 }
    Fields
    kind

    string

    The type of the API resource. For claimHistory resources, this value is youtubePartner#claimHistory .
    event[]

    object ( ClaimEvent )

    A list of claim history events.
    id

    string

    The ID that YouTube assigns and uses to uniquely identify the claim.
    uploaderChannelId

    string

    The external channel id of claimed video's uploader.

    ClaimEvent

    A claimEvent resource represents a single event in claim's life cycle.

    JSON representation 
     { 
 "time" 
 : 
 string 
 , 
 "kind" 
 : 
 string 
 , 
 "type" 
 : 
 string 
 , 
 "reason" 
 : 
 string 
 , 
 "source" 
 : 
 { 
 object (  Source 
 
) 
 } 
 , 
 "typeDetails" 
 : 
 { 
 object (  TypeDetails 
 
) 
 } 
 }
    Fields
    time

    string

    The time when the event occurred.
    kind

    string

    The type of the API resource. For claimEvent resources, this value is youtubePartner#claimEvent .
    type

    string

    Type of the event.
    reason

    string

    Reason of the event.
    source

    object ( Source )

    Data related to source of the event.
    typeDetails

    object ( TypeDetails )

    Details of event's type.

    Source

    Claim source

    JSON representation 
     { 
 "type" 
 : 
 string 
 , 
 "userEmail" 
 : 
 string 
 , 
 "contentOwnerId" 
 : 
 string 
 }
    Fields
    type

    string

    Type of the event source.
    userEmail

    string

    Email of user who initiated the event.
    contentOwnerId

    string

    Id of content owner that initiated the event.

    TypeDetails

    Details of event's type.

    JSON representation 
     { 
 "disputeReason" 
 : 
 string 
 , 
 "updateStatus" 
 : 
 string 
 , 
 "disputeNotes" 
 : 
 string 
 , 
 "appealExplanation" 
 : 
 string 
 }
    Fields
    disputeReason

    string

    Dispute reason for dispute_create and dispute_appeal events.
    updateStatus

    string

    Status that was a result of update for claim_update event.
    disputeNotes

    string

    Dispute notes for dispute_create events.
    appealExplanation

    string

    Appeal explanations for dispute_appeal event.

    Methods

    get

    		Retrieves the claim history for a specified claim.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: