Files
2026-04-28 15:13:50 +02:00

700 lines
20 KiB
PHP

<?php
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
*
* This source code is licensed under the license found in the
* LICENSE file in the root directory of this source tree.
*/
namespace FacebookPixelPlugin\FacebookAds\Object;
use FacebookPixelPlugin\FacebookAds\ApiRequest;
use FacebookPixelPlugin\FacebookAds\Cursor;
use FacebookPixelPlugin\FacebookAds\Http\RequestInterface;
use FacebookPixelPlugin\FacebookAds\TypeChecker;
use FacebookPixelPlugin\FacebookAds\Object\Fields\AdVideoFields;
use FacebookPixelPlugin\FacebookAds\Object\Values\AdVideoBackdatedTimeGranularityValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\AdVideoContainerTypeValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\AdVideoContentCategoryValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\AdVideoFormattingValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\AdVideoOriginalProjectionTypeValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\AdVideoSwapModeValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\AdVideoTypeValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\AdVideoUnpublishedContentTypeValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\AdVideoUploadPhaseValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\AdVideoValidationAdPlacementsValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\AdVideoVideoStateValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\CommentCommentPrivacyValueValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\CommentFilterValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\CommentLiveFilterValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\CommentOrderValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\InsightsResultPeriodValues;
use FacebookPixelPlugin\FacebookAds\Object\Traits\CannotDelete;
use FacebookPixelPlugin\FacebookAds\Object\Traits\CannotUpdate;
use FacebookPixelPlugin\FacebookAds\Object\Traits\FieldValidation;
/**
* This class is auto-generated.
*
* For any issues or feature requests related to this class, please let us know
* on github and we'll fix in our codegen framework. We'll not be able to accept
* pull request for this class.
*
*/
class AdVideo extends AbstractCrudObject {
/**
* @deprecated getEndpoint function is deprecated
*/
protected function getEndpoint() {
return 'advideos';
}
/**
* @return AdVideoFields
*/
public static function getFieldsEnum() {
return AdVideoFields::getInstance();
}
protected static function getReferencedEnums() {
$ref_enums = array();
$ref_enums['ContainerType'] = AdVideoContainerTypeValues::getInstance()->getValues();
$ref_enums['ContentCategory'] = AdVideoContentCategoryValues::getInstance()->getValues();
$ref_enums['Formatting'] = AdVideoFormattingValues::getInstance()->getValues();
$ref_enums['OriginalProjectionType'] = AdVideoOriginalProjectionTypeValues::getInstance()->getValues();
$ref_enums['SwapMode'] = AdVideoSwapModeValues::getInstance()->getValues();
$ref_enums['UnpublishedContentType'] = AdVideoUnpublishedContentTypeValues::getInstance()->getValues();
$ref_enums['UploadPhase'] = AdVideoUploadPhaseValues::getInstance()->getValues();
$ref_enums['VideoState'] = AdVideoVideoStateValues::getInstance()->getValues();
$ref_enums['ValidationAdPlacements'] = AdVideoValidationAdPlacementsValues::getInstance()->getValues();
$ref_enums['Type'] = AdVideoTypeValues::getInstance()->getValues();
$ref_enums['BackdatedTimeGranularity'] = AdVideoBackdatedTimeGranularityValues::getInstance()->getValues();
return $ref_enums;
}
public function getBoostAdsList(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/boost_ads_list',
new AbstractCrudObject(),
'EDGE',
array(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getCaptions(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/captions',
new AbstractCrudObject(),
'EDGE',
array(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createCapTIOn(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'captions_file' => 'file',
'default_locale' => 'string',
'locales_to_delete' => 'list<string>',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/captions',
new AdVideo(),
'EDGE',
AdVideo::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getCollaborators(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/collaborators',
new AbstractCrudObject(),
'EDGE',
array(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createCollaborator(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'target_id' => 'string',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/collaborators',
new AdVideo(),
'EDGE',
AdVideo::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getComments(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'filter' => 'filter_enum',
'live_filter' => 'live_filter_enum',
'order' => 'order_enum',
'since' => 'datetime',
);
$enums = array(
'filter_enum' => CommentFilterValues::getInstance()->getValues(),
'live_filter_enum' => CommentLiveFilterValues::getInstance()->getValues(),
'order_enum' => CommentOrderValues::getInstance()->getValues(),
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/comments',
new Comment(),
'EDGE',
Comment::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createComment(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'attachment_id' => 'string',
'attachment_share_url' => 'string',
'attachment_url' => 'string',
'comment_privacy_value' => 'comment_privacy_value_enum',
'facepile_mentioned_ids' => 'list<string>',
'feedback_source' => 'string',
'is_offline' => 'bool',
'message' => 'string',
'nectar_module' => 'string',
'object_id' => 'string',
'parent_comment_id' => 'Object',
'text' => 'string',
'tracking' => 'string',
);
$enums = array(
'comment_privacy_value_enum' => CommentCommentPrivacyValueValues::getInstance()->getValues(),
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/comments',
new Comment(),
'EDGE',
Comment::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getCrosspostSharedPages(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/crosspost_shared_pages',
new Page(),
'EDGE',
Page::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createGamingClipCreate(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'duration_seconds' => 'float',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/gaming_clip_create',
new AdVideo(),
'EDGE',
AdVideo::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getLikes(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/likes',
new Profile(),
'EDGE',
Profile::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createLike(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'feedback_source' => 'string',
'nectar_module' => 'string',
'notify' => 'bool',
'tracking' => 'string',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/likes',
new AdVideo(),
'EDGE',
AdVideo::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getPollSettings(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/poll_settings',
new AbstractCrudObject(),
'EDGE',
array(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getPolls(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/polls',
new VideoPoll(),
'EDGE',
VideoPoll::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createPoll(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'close_after_voting' => 'bool',
'correct_option' => 'unsigned int',
'default_open' => 'bool',
'options' => 'list<string>',
'question' => 'string',
'show_gradient' => 'bool',
'show_results' => 'bool',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/polls',
new VideoPoll(),
'EDGE',
VideoPoll::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getSponsorTags(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/sponsor_tags',
new Page(),
'EDGE',
Page::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getTags(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/tags',
new TaggableSubject(),
'EDGE',
TaggableSubject::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getThumbnails(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/thumbnails',
new VideoThumbnail(),
'EDGE',
VideoThumbnail::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createThumbnail(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'is_preferred' => 'bool',
'source' => 'file',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/thumbnails',
new AdVideo(),
'EDGE',
AdVideo::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getVideoInsights(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'metric' => 'list<Object>',
'period' => 'period_enum',
'since' => 'datetime',
'until' => 'datetime',
);
$enums = array(
'period_enum' => InsightsResultPeriodValues::getInstance()->getValues(),
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/video_insights',
new InsightsResult(),
'EDGE',
InsightsResult::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function deleteSelf(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_DELETE,
'/',
new AbstractCrudObject(),
'NODE',
array(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getSelf(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/',
new AdVideo(),
'NODE',
AdVideo::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function updateSelf(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'ad_breaks' => 'list',
'allow_bm_crossposting' => 'bool',
'allow_crossposting_for_pages' => 'list<Object>',
'backdated_time' => 'datetime',
'backdated_time_granularity' => 'backdated_time_granularity_enum',
'call_to_action' => 'Object',
'content_category' => 'content_category_enum',
'content_tags' => 'list<string>',
'custom_labels' => 'list<string>',
'description' => 'string',
'direct_share_status' => 'unsigned int',
'embeddable' => 'bool',
'expiration' => 'Object',
'expire_now' => 'bool',
'increment_play_count' => 'bool',
'name' => 'string',
'preferred_thumbnail_id' => 'string',
'privacy' => 'string',
'publish_to_news_feed' => 'bool',
'publish_to_videos_tab' => 'bool',
'published' => 'bool',
'scheduled_publish_time' => 'unsigned int',
'social_actions' => 'bool',
'sponsor_id' => 'string',
'sponsor_relationship' => 'unsigned int',
'tags' => 'list<string>',
'target' => 'string',
'universal_video_id' => 'string',
);
$enums = array(
'backdated_time_granularity_enum' => AdVideoBackdatedTimeGranularityValues::getInstance()->getValues(),
'content_category_enum' => AdVideoContentCategoryValues::getInstance()->getValues(),
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/',
new AdVideo(),
'NODE',
AdVideo::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
use FieldValidation;
public function create(array $params = array()) {
$data = $this->exportData();
$source = null;
if (array_key_exists(AdVideoFields::SOURCE, $data)) {
$source = $data[AdVideoFields::SOURCE];
unset($data[AdVideoFields::SOURCE]);
}
$params = array_merge($data, $params);
$request = $this->getApi()->prepareRequest(
'/'.$this->assureParentId().'/'.$this->getEndpoint(),
RequestInterface::METHOD_POST,
$params
);
$request->setLastLevelDomain('graph-video');
if ($source) {
$request->getFileParams()->offsetSet(AdVideoFields::SOURCE, $source);
}
$response = $this->getApi()->executeRequest($request);
$data = $response->getContent();
$this->data[static::FIELD_ID]
= is_string($data) ? $data : (string) $data[static::FIELD_ID];
return $this;
}
/**
* @param array $fields
* @param array $params
* @return Cursor
*/
public function getVideoThumbnails(
array $fields = array(), array $params = array()) {
return $this->getManyByConnection(
VideoThumbnail::className(), $fields, $params, 'thumbnails');
}
}