ActivityContentDetailsPromotedItem
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.
Details about a resource which is being promoted.
Tags
Table of Contents
Constants
- CTA_TYPE_CTA_TYPE_UNSPECIFIED : mixed = 'ctaTypeUnspecified'
- A `ctaType` of `ctaTypeUnspecified`.
- CTA_TYPE_VISIT_ADVERTISER_SITE : mixed = 'visitAdvertiserSite'
- A `ctaType` of `visitAdvertiserSite`.
Properties
- $adTag : string|null
- $clickTrackingUrl : string|null
- $creativeViewUrl : string|null
- $ctaType : string|null
- $customCtaButtonText : string|null
- $descriptionText : string|null
- $destinationUrl : string|null
- $forecastingUrl : array<int, string>|null
- $impressionUrl : array<int, string>|null
- $videoId : string|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()}.
Constants
CTA_TYPE_CTA_TYPE_UNSPECIFIED
A `ctaType` of `ctaTypeUnspecified`.
public
mixed
CTA_TYPE_CTA_TYPE_UNSPECIFIED
= 'ctaTypeUnspecified'
CTA_TYPE_VISIT_ADVERTISER_SITE
A `ctaType` of `visitAdvertiserSite`.
public
mixed
CTA_TYPE_VISIT_ADVERTISER_SITE
= 'visitAdvertiserSite'
Properties
$adTag
public
string|null
$adTag
The URL the client should fetch to request a promoted item.
$clickTrackingUrl
public
string|null
$clickTrackingUrl
The URL the client should ping to indicate that the user clicked through on this promoted item.
$creativeViewUrl
public
string|null
$creativeViewUrl
The URL the client should ping to indicate that the user was shown this promoted item.
$ctaType
public
string|null
$ctaType
The type of call-to-action, a message to the user indicating action that can be
taken. One of the CTA_TYPE_* constants.
$customCtaButtonText
public
string|null
$customCtaButtonText
The custom call-to-action button text. If specified, it will override the default button text for the cta_type.
$descriptionText
public
string|null
$descriptionText
The text description to accompany the promoted item.
$destinationUrl
public
string|null
$destinationUrl
The URL the client should direct the user to, if the user chooses to visit the advertiser's website.
$forecastingUrl
public
array<int, string>|null
$forecastingUrl
The list of forecasting URLs. The client should ping all of these URLs when a promoted item is not available, to indicate that a promoted item could have been shown.
$impressionUrl
public
array<int, string>|null
$impressionUrl
The list of impression URLs. The client should ping all of these URLs to indicate that the user was shown this promoted item.
$videoId
public
string|null
$videoId
The ID that YouTube uses to uniquely identify the promoted video.
$casts
Attribute name => type token (`"LiveChatMessageSnippet"`, `"Array of Thumbnail"`, `"Map of VideoLocalization"`), used to hydrate nested objects into parts.
protected
array<string, string>
$casts
= []
$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