Inserts a new resource into this collection.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

  • https://www.googleapis.com/auth/youtube
  • https://www.googleapis.com/auth/youtube.force-ssl
  • https://www.googleapis.com/auth/youtubepartner

If unset, the scope for this method defaults to https://www.googleapis.com/auth/youtube. You can set the scope for this method like this: youtube3 --scope <scope> subscriptions insert ...

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Subscription:
  content-details:
    activity-type: string
    new-item-count: integer
    total-item-count: integer
  etag: string
  id: string
  kind: string
  snippet:
    channel-id: string
    channel-title: string
    description: string
    published-at: string
    resource-id:
      channel-id: string
      kind: string
      playlist-id: string
      video-id: string
    thumbnails:
      default:
        height: integer
        url: string
        width: integer
      high:
        height: integer
        url: string
        width: integer
      maxres:
        height: integer
        url: string
        width: integer
      medium:
        height: integer
        url: string
        width: integer
      standard:
        height: integer
        url: string
        width: integer
    title: string
  subscriber-snippet:
    channel-id: string
    description: string
    thumbnails:
      default:
        height: integer
        url: string
        width: integer
      high:
        height: integer
        url: string
        width: integer
      maxres:
        height: integer
        url: string
        width: integer
      medium:
        height: integer
        url: string
        width: integer
      standard:
        height: integer
        url: string
        width: integer
    title: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .content-details activity-type=et
    • The type of activity this subscription is for (only uploads, everything).
  • new-item-count=5
    • The number of new items in the subscription since its content was last read.
  • total-item-count=74

    • The approximate number of items that the subscription points to.
  • .. etag=et

    • Etag of this resource.
  • id=accusam
    • The ID that YouTube uses to uniquely identify the subscription.
  • kind=sit
    • Identifies what kind of resource this is. Value: the fixed string "youtube#subscription".
  • snippet channel-id=voluptua.
    • The ID that YouTube uses to uniquely identify the subscriber's channel.
  • channel-title=kasd
    • Channel title for the channel that the subscription belongs to.
  • description=no
    • The subscription's details.
  • published-at=amet.
    • The date and time that the subscription was created.
  • resource-id channel-id=aliquyam
    • The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
  • kind=accusam
    • The type of the API resource.
  • playlist-id=sanctus
    • The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
  • video-id=duo

    • The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
  • ..thumbnails.default height=38

    • (Optional) Height of the thumbnail image.
  • url=eos
    • The thumbnail image's URL.
  • width=90

    • (Optional) Width of the thumbnail image.
  • ..high height=38

    • (Optional) Height of the thumbnail image.
  • url=sanctus
    • The thumbnail image's URL.
  • width=39

    • (Optional) Width of the thumbnail image.
  • ..maxres height=78

    • (Optional) Height of the thumbnail image.
  • url=lorem
    • The thumbnail image's URL.
  • width=97

    • (Optional) Width of the thumbnail image.
  • ..medium height=43

    • (Optional) Height of the thumbnail image.
  • url=sea
    • The thumbnail image's URL.
  • width=22

    • (Optional) Width of the thumbnail image.
  • ..standard height=4

    • (Optional) Height of the thumbnail image.
  • url=magna
    • The thumbnail image's URL.
  • width=78

    • (Optional) Width of the thumbnail image.
  • ... title=lorem

    • The subscription's title.
  • ..subscriber-snippet channel-id=tempor

    • The channel ID of the subscriber.
  • description=consetetur
    • The description of the subscriber.
  • thumbnails.default height=54
    • (Optional) Height of the thumbnail image.
  • url=ipsum
    • The thumbnail image's URL.
  • width=29

    • (Optional) Width of the thumbnail image.
  • ..high height=57

    • (Optional) Height of the thumbnail image.
  • url=dolor
    • The thumbnail image's URL.
  • width=81

    • (Optional) Width of the thumbnail image.
  • ..maxres height=9

    • (Optional) Height of the thumbnail image.
  • url=et
    • The thumbnail image's URL.
  • width=0

    • (Optional) Width of the thumbnail image.
  • ..medium height=90

    • (Optional) Height of the thumbnail image.
  • url=sea
    • The thumbnail image's URL.
  • width=66

    • (Optional) Width of the thumbnail image.
  • ..standard height=23

    • (Optional) Height of the thumbnail image.
  • url=ipsum
    • The thumbnail image's URL.
  • width=34

    • (Optional) Width of the thumbnail image.
  • ... title=ipsum

    • The title of the subscriber.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.
  • -p access-token=string

    • OAuth access token.
  • -p alt=string

    • Data format for response.
  • -p callback=string

    • JSONP
  • -p fields=string

    • Selector specifying which fields to include in a partial response.
  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • -p oauth-token=string

    • OAuth 2.0 token for the current user.
  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.
  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").
  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").