youtubeapi-8.x-1.2/config/api/search.yml

#Youtube API Settings.
#Generated on : 2017-05-15 12:15:19

method: search

#Request Parameters
request_uri: https://www.googleapis.com/youtube/v3/search
request:
  part:
    apitype: string
    options:
      - id
      - snippet
    default: id
    multiple: true
    required: true
  forContentOwner:
    apitype: boolean
  forDeveloper:
    apitype: boolean
  forMine:
    apitype: boolean
  relatedToVideoId:
    apitype: string
  channelId:
    apitype: string
  channelType:
    apitype: string
    options:
      - any
      - show
  eventType:
    apitype: string
    options:
      - completed
      - live
      - upcoming
  location:
    apitype: string
    options:
      - location
      - locationRadius
  locationRadius:
    apitype: string
  maxResults:
    apitype: unsigned integer
  onBehalfOfContentOwner:
    apitype: string
  order:
    apitype: string
    options:
      - date
      - rating
      - relevance
      - title
      - videoCount
      - viewCount
  pageToken:
    apitype: string
  publishedAfter:
    apitype: datetime
  publishedBefore:
    apitype: datetime
  q:
    apitype: string
  regionCode:
    apitype: string
  relevanceLanguage:
    apitype: string
  safeSearch:
    apitype: string
    options:
      - moderate
      - none
      - strict
  topicId:
    apitype: string
  type:
    apitype: string
    options:
      - channel
      - playlist
      - video
    multiple: true
  videoCaption:
    apitype: string
    options:
      - any
      - closedCaption
      - none
  videoCategoryId:
    apitype: string
  videoDefinition:
    apitype: string
    options:
      - any
      - high
      - standard
  videoDimension:
    apitype: string
    options:
      - 2d
      - 3d
      - any
  videoDuration:
    apitype: string
    options:
      - any
      - long
      - medium
      - short
  videoEmbeddable:
    apitype: string
    options:
      - any
      - true
  videoLicense:
    apitype: string
    options:
      - any
      - creativeCommon
      - youtube
  videoSyndicated:
    apitype: string
    options:
      - any
      - true
  videoType:
    apitype: string
    options:
      - any
      - episode
      - movie

#Response Parameters
response:
  kind:
    apitype: string
  etag:
    apitype: etag
  nextPageToken:
    apitype: string
  prevPageToken:
    apitype: string
  regionCode:
    apitype: string
  pageInfo:
    apitype: object
  pageInfo.totalResults:
    apitype: integer
  pageInfo.resultsPerPage:
    apitype: integer
  items:
    apitype: list
    isarray: true