Channel
extends Part
in package
This file is generated from spec/discovery.json (YouTube Data API v3, revision 20260924) by tools/generate.php. Do not edit it by hand - run `composer spec:build` instead.
A channel resource contains information about a YouTube channel.
Tags
Table of Contents
Properties
- $auditDetails : ChannelAuditDetails|null
- $brandingSettings : ChannelBrandingSettings|null
- $contentDetails : ChannelContentDetails|null
- $contentOwnerDetails : ChannelContentOwnerDetails|null
- $conversionPings : ChannelConversionPings|null
- $etag : string|null
- $id : string|null
- $kind : string|null
- $localizations : array<string, ChannelLocalization>|null
- $snippet : ChannelSnippet|null
- $statistics : ChannelStatistics|null
- $status : ChannelStatus|null
- $topicDetails : ChannelTopicDetails|null
- $casts : array<string, string>
- Attribute name => type token (`"LiveChatMessageSnippet"`, `"Array of Thumbnail"`, `"Map of VideoLocalization"`), used to hydrate nested objects into parts.
- $dates : array<int, string>
- Attribute names holding RFC 3339 timestamps, read back as {@see CarbonImmutable}. They are stored and serialised as the strings YouTube sent.
- $youtube : ?YouTube
Methods
- __construct() : mixed
- __debugInfo() : array<string, mixed>
- __get() : mixed
- __isset() : bool
- __set() : void
- __toString() : string
- __unset() : void
- attributeExists() : bool
- fill() : void
- getAttribute() : mixed
- getCasts() : array<string, string>
- getDates() : array<int, string>
- getRawAttribute() : mixed
- Reads straight from the attribute bag, skipping the `get{Key}Attribute` hook.
- getRawAttributes() : array<string, mixed>
- getYouTube() : YouTube
- The client this part came from.
- jsonSerialize() : array<string, mixed>
- The payload this part would be sent back to YouTube as: nested parts and collections flattened, timestamps as RFC 3339 strings.
- offsetExists() : bool
- offsetGet() : mixed
- offsetSet() : void
- offsetUnset() : void
- setAttribute() : void
- factory() : Factory
- Builds another part from the same client - for nested objects.
- setRawAttribute() : void
- Writes straight to the attribute bag, skipping the `set{Key}Attribute` hook and any cast. For use *inside* a mutator, which would otherwise have no way to store its shaped value without recursing through {@see setAttribute()}.
Properties
$auditDetails
public
ChannelAuditDetails|null
$auditDetails
The auditionDetails object encapsulates channel data that is relevant for YouTube Partners during the audition process.
$brandingSettings
public
ChannelBrandingSettings|null
$brandingSettings
The brandingSettings object encapsulates information about the branding of the channel.
$contentDetails
public
ChannelContentDetails|null
$contentDetails
The contentDetails object encapsulates information about the channel's content.
$contentOwnerDetails
public
ChannelContentOwnerDetails|null
$contentOwnerDetails
The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.
$conversionPings
public
ChannelConversionPings|null
$conversionPings
Deprecated. The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.
$etag
public
string|null
$etag
Etag of this resource.
$id
public
string|null
$id
The ID that YouTube uses to uniquely identify the channel.
$kind
public
string|null
$kind
Identifies what kind of resource this is. Value: the fixed string "youtube#channel".
$localizations
public
array<string, ChannelLocalization>|null
$localizations
Localizations for different languages
$snippet
public
ChannelSnippet|null
$snippet
The snippet object contains basic details about the channel, such as its title, description, and thumbnail images.
$statistics
public
ChannelStatistics|null
$statistics
The statistics object encapsulates statistics for the channel.
$status
public
ChannelStatus|null
$status
The status object encapsulates information about the privacy status of the channel.
$topicDetails
public
ChannelTopicDetails|null
$topicDetails
The topicDetails object encapsulates information about Freebase topics associated with the channel.
$casts
Attribute name => type token (`"LiveChatMessageSnippet"`, `"Array of Thumbnail"`, `"Map of VideoLocalization"`), used to hydrate nested objects into parts.
protected
array<string, string>
$casts
= ['auditDetails' => 'ChannelAuditDetails', 'brandingSettings' => 'ChannelBrandingSettings', 'contentDetails' => 'ChannelContentDetails', 'contentOwnerDetails' => 'ChannelContentOwnerDetails', 'conversionPings' => 'ChannelConversionPings', 'localizations' => 'Map of ChannelLocalization', 'snippet' => 'ChannelSnippet', 'statistics' => 'ChannelStatistics', 'status' => 'ChannelStatus', 'topicDetails' => 'ChannelTopicDetails']
$dates
Attribute names holding RFC 3339 timestamps, read back as {@see CarbonImmutable}. They are stored and serialised as the strings YouTube sent.
protected
array<int, string>
$dates
= []
$youtube read-only
protected
?YouTube
$youtube
= null
Methods
__construct()
public
__construct([YouTube|null $youtube = null ][, array<string, mixed>|object $attributes = [] ]) : mixed
Parameters
- $youtube : YouTube|null = null
-
The client, for behaviour that calls the API.
- $attributes : array<string, mixed>|object = []
__debugInfo()
public
__debugInfo() : array<string, mixed>
Return values
array<string, mixed>__get()
public
__get(string $name) : mixed
Parameters
- $name : string
__isset()
public
__isset(string $name) : bool
Parameters
- $name : string
Return values
bool__set()
public
__set(string $name, mixed $value) : void
Parameters
- $name : string
- $value : mixed
__toString()
public
__toString() : string
Return values
string__unset()
public
__unset(string $name) : void
Parameters
- $name : string
attributeExists()
public
attributeExists(string $key) : bool
Parameters
- $key : string
Return values
boolfill()
public
fill(array<string, mixed> $attributes) : void
Parameters
- $attributes : array<string, mixed>
getAttribute()
public
getAttribute(string $key) : mixed
Parameters
- $key : string
getCasts()
public
getCasts() : array<string, string>
Return values
array<string, string>getDates()
public
getDates() : array<int, string>
Return values
array<int, string>getRawAttribute()
Reads straight from the attribute bag, skipping the `get{Key}Attribute` hook.
public
getRawAttribute(string $key) : mixed
Parameters
- $key : string
getRawAttributes()
public
getRawAttributes() : array<string, mixed>
Return values
array<string, mixed>getYouTube()
The client this part came from.
public
getYouTube() : YouTube
Tags
Return values
YouTubejsonSerialize()
The payload this part would be sent back to YouTube as: nested parts and collections flattened, timestamps as RFC 3339 strings.
public
jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>offsetExists()
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
booloffsetGet()
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
offsetSet()
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
- $value : mixed
offsetUnset()
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
setAttribute()
public
setAttribute(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed
factory()
Builds another part from the same client - for nested objects.
protected
factory() : Factory
Return values
FactorysetRawAttribute()
Writes straight to the attribute bag, skipping the `set{Key}Attribute` hook and any cast. For use *inside* a mutator, which would otherwise have no way to store its shaped value without recursing through {@see setAttribute()}.
protected
setRawAttribute(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed