310 lines
8.5 KiB
PHP
310 lines
8.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\OfflineConversionDataSetFields;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdAccountActionSourceValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\BusinessActionSourceValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\CustomAudienceActionSourceValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\OfflineConversionDataSetUploadOrderValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\OfflineConversionDataSetUploadSortByValues;
|
|
|
|
/**
|
|
* 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 OfflineConversionDataSet extends AbstractCrudObject {
|
|
|
|
/**
|
|
* @return OfflineConversionDataSetFields
|
|
*/
|
|
public static function getFieldsEnum() {
|
|
return OfflineConversionDataSetFields::getInstance();
|
|
}
|
|
|
|
protected static function getReferencedEnums() {
|
|
$ref_enums = array();
|
|
return $ref_enums;
|
|
}
|
|
|
|
|
|
public function getAdAccounts(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'business' => 'string',
|
|
);
|
|
$enums = array(
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/adaccounts',
|
|
new AdAccount(),
|
|
'EDGE',
|
|
AdAccount::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getAgencies(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,
|
|
'/agencies',
|
|
new Business(),
|
|
'EDGE',
|
|
Business::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getAudiences(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'action_source' => 'action_source_enum',
|
|
'ad_account' => 'string',
|
|
);
|
|
$enums = array(
|
|
'action_source_enum' => CustomAudienceActionSourceValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/audiences',
|
|
new CustomAudience(),
|
|
'EDGE',
|
|
CustomAudience::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(
|
|
'ad_account' => 'string',
|
|
);
|
|
$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 getServerEventsPermittedBusiness(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,
|
|
'/server_events_permitted_business',
|
|
new Business(),
|
|
'EDGE',
|
|
Business::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getSharedAccounts(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'action_source' => 'action_source_enum',
|
|
'business' => 'string',
|
|
);
|
|
$enums = array(
|
|
'action_source_enum' => AdAccountActionSourceValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/shared_accounts',
|
|
new AdAccount(),
|
|
'EDGE',
|
|
AdAccount::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getSharedAgencies(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'action_source' => 'action_source_enum',
|
|
);
|
|
$enums = array(
|
|
'action_source_enum' => BusinessActionSourceValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/shared_agencies',
|
|
new Business(),
|
|
'EDGE',
|
|
Business::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getStats(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'aggr_time' => 'aggr_time_enum',
|
|
'end' => 'int',
|
|
'granularity' => 'granularity_enum',
|
|
'skip_empty_values' => 'bool',
|
|
'start' => 'int',
|
|
'user_timezone_id' => 'unsigned int',
|
|
);
|
|
$enums = array(
|
|
'aggr_time_enum' => array(
|
|
'event_time',
|
|
'upload_time',
|
|
),
|
|
'granularity_enum' => array(
|
|
'daily',
|
|
'hourly',
|
|
'six_hourly',
|
|
),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/stats',
|
|
new AbstractCrudObject(),
|
|
'EDGE',
|
|
array(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getUploads(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'end_time' => 'datetime',
|
|
'order' => 'order_enum',
|
|
'sort_by' => 'sort_by_enum',
|
|
'start_time' => 'datetime',
|
|
'upload_tag' => 'string',
|
|
);
|
|
$enums = array(
|
|
'order_enum' => OfflineConversionDataSetUploadOrderValues::getInstance()->getValues(),
|
|
'sort_by_enum' => OfflineConversionDataSetUploadSortByValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/uploads',
|
|
new OfflineConversionDataSetUpload(),
|
|
'EDGE',
|
|
OfflineConversionDataSetUpload::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(
|
|
);
|
|
$enums = array(
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/',
|
|
new OfflineConversionDataSet(),
|
|
'NODE',
|
|
OfflineConversionDataSet::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
}
|