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

271 lines
7.1 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\AdStudyObjectiveFields;
use FacebookPixelPlugin\FacebookAds\Object\Values\AdStudyObjectiveTypeValues;
/**
* 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 AdStudyObjective extends AbstractCrudObject {
/**
* @return AdStudyObjectiveFields
*/
public static function getFieldsEnum() {
return AdStudyObjectiveFields::getInstance();
}
protected static function getReferencedEnums() {
$ref_enums = array();
$ref_enums['Type'] = AdStudyObjectiveTypeValues::getInstance()->getValues();
return $ref_enums;
}
public function getAdsPixels(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,
'/adspixels',
new AdsPixel(),
'EDGE',
AdsPixel::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getApplications(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,
'/applications',
new Application(),
'EDGE',
Application::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getBrandRequests(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,
'/brand_requests',
new BrandRequest(),
'EDGE',
BrandRequest::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getCustomConversions(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,
'/customconversions',
new CustomConversion(),
'EDGE',
CustomConversion::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getOfflineConversionDataSets(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,
'/offline_conversion_data_sets',
new OfflineConversionDataSet(),
'EDGE',
OfflineConversionDataSet::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getPartnerPrivateStudies(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,
'/partner_private_studies',
new Business(),
'EDGE',
Business::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getPartnerStudies(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,
'/partnerstudies',
new PartnerStudy(),
'EDGE',
PartnerStudy::getFieldsEnum()->getValues(),
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(
'breakdowns' => 'list<breakdowns_enum>',
'ds' => 'string',
);
$enums = array(
'breakdowns_enum' => array(
'age',
'cell_id',
'country',
'gender',
),
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/',
new AdStudyObjective(),
'NODE',
AdStudyObjective::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(
'adspixels' => 'list<Object>',
'applications' => 'list<Object>',
'customconversions' => 'list<Object>',
'is_primary' => 'bool',
'name' => 'string',
'offline_conversion_data_sets' => 'list<Object>',
'offsite_datasets' => 'list<Object>',
'product_catalogs' => 'list<Object>',
'product_sets' => 'list<Object>',
'type' => 'type_enum',
);
$enums = array(
'type_enum' => AdStudyObjectiveTypeValues::getInstance()->getValues(),
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/',
new AdStudyObjective(),
'NODE',
AdStudyObjective::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
}