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

256 lines
6.5 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\AdStudyFields;
use FacebookPixelPlugin\FacebookAds\Object\Values\AdStudyTypeValues;
/**
* 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 AdStudy extends AbstractCrudObject {
/**
* @deprecated getEndpoint function is deprecated
*/
protected function getEndpoint() {
return 'ad_studies';
}
/**
* @return AdStudyFields
*/
public static function getFieldsEnum() {
return AdStudyFields::getInstance();
}
protected static function getReferencedEnums() {
$ref_enums = array();
$ref_enums['Type'] = AdStudyTypeValues::getInstance()->getValues();
return $ref_enums;
}
public function getCells(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,
'/cells',
new AdStudyCell(),
'EDGE',
AdStudyCell::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createCheckPoint(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'checkpoint_data' => 'string',
'checkpoint_name' => 'string',
'component' => 'string',
'instance_id' => 'string',
'run_id' => 'string',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/checkpoint',
new AdStudy(),
'EDGE',
AdStudy::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getInstances(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,
'/instances',
new PrivateLiftStudyInstance(),
'EDGE',
PrivateLiftStudyInstance::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createInstance(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'breakdown_key' => 'map',
'run_id' => 'string',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/instances',
new PrivateLiftStudyInstance(),
'EDGE',
PrivateLiftStudyInstance::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getObjectives(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,
'/objectives',
new AdStudyObjective(),
'EDGE',
AdStudyObjective::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 AdStudy(),
'NODE',
AdStudy::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(
'cells' => 'list<Object>',
'client_business' => 'string',
'confidence_level' => 'float',
'cooldown_start_time' => 'int',
'description' => 'string',
'end_time' => 'int',
'name' => 'string',
'objectives' => 'list<Object>',
'observation_end_time' => 'int',
'start_time' => 'int',
'type' => 'type_enum',
'viewers' => 'list<int>',
);
$enums = array(
'type_enum' => AdStudyTypeValues::getInstance()->getValues(),
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/',
new AdStudy(),
'NODE',
AdStudy::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
}