783 lines
28 KiB
PHP
783 lines
28 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\AdSetFields;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdActivityCategoryValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdAsyncRequestStatusesValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdCampaignDeliveryEstimateOptimizationGoalValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdDatePresetValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetAutomaticManualStateValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetBidStrategyValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetBillingEventValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetBudgetSourceValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetConfiguredStatusValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetCreativeSequenceRepetitionPatternValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetDatePresetValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetDestinationTypeValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetEffectiveStatusValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetExecutionOptionsValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetFullFunnelExplorationModeValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetMultiOptimizationGoalWeightValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetOperatorValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetOptimizationGoalValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetOptimizationSubEventValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetRegionalRegulatedCategoriesValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetStatusOptionValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetStatusValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdSetTuneForCategoryValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdsInsightsActionAttributionWindowsValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdsInsightsActionBreakdownsValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdsInsightsActionReportTimeValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdsInsightsBreakdownsValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdsInsightsDatePresetValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdsInsightsLevelValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\AdsInsightsSummaryActionBreakdownsValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\HighDemandPeriodBudgetValueTypeValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\MessageDeliveryEstimateOptimizationGoalValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Values\MessageDeliveryEstimatePacingTypeValues;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Traits\AdLabelAwareCrudObjectTrait;
|
|
use FacebookPixelPlugin\FacebookAds\Object\Traits\ObjectValidation;
|
|
|
|
/**
|
|
* 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 AdSet extends AbstractArchivableCrudObject
|
|
implements CanRedownloadInterface {
|
|
|
|
use AdLabelAwareCrudObjectTrait;
|
|
use ObjectValidation;
|
|
|
|
/**
|
|
* @deprecated getEndpoint function is deprecated
|
|
*/
|
|
protected function getEndpoint() {
|
|
return 'adsets';
|
|
}
|
|
|
|
/**
|
|
* @return AdSetFields
|
|
*/
|
|
public static function getFieldsEnum() {
|
|
return AdSetFields::getInstance();
|
|
}
|
|
|
|
protected static function getReferencedEnums() {
|
|
$ref_enums = array();
|
|
$ref_enums['BidStrategy'] = AdSetBidStrategyValues::getInstance()->getValues();
|
|
$ref_enums['BillingEvent'] = AdSetBillingEventValues::getInstance()->getValues();
|
|
$ref_enums['ConfiguredStatus'] = AdSetConfiguredStatusValues::getInstance()->getValues();
|
|
$ref_enums['EffectiveStatus'] = AdSetEffectiveStatusValues::getInstance()->getValues();
|
|
$ref_enums['OptimizationGoal'] = AdSetOptimizationGoalValues::getInstance()->getValues();
|
|
$ref_enums['Status'] = AdSetStatusValues::getInstance()->getValues();
|
|
$ref_enums['AutomaticManualState'] = AdSetAutomaticManualStateValues::getInstance()->getValues();
|
|
$ref_enums['BudgetSource'] = AdSetBudgetSourceValues::getInstance()->getValues();
|
|
$ref_enums['CreativeSequenceRepetitionPattern'] = AdSetCreativeSequenceRepetitionPatternValues::getInstance()->getValues();
|
|
$ref_enums['DatePreset'] = AdSetDatePresetValues::getInstance()->getValues();
|
|
$ref_enums['DestinationType'] = AdSetDestinationTypeValues::getInstance()->getValues();
|
|
$ref_enums['ExecutionOptions'] = AdSetExecutionOptionsValues::getInstance()->getValues();
|
|
$ref_enums['FullFunnelExplorationMode'] = AdSetFullFunnelExplorationModeValues::getInstance()->getValues();
|
|
$ref_enums['MultiOptimizationGoalWeight'] = AdSetMultiOptimizationGoalWeightValues::getInstance()->getValues();
|
|
$ref_enums['OptimizationSubEvent'] = AdSetOptimizationSubEventValues::getInstance()->getValues();
|
|
$ref_enums['RegionalRegulatedCategories'] = AdSetRegionalRegulatedCategoriesValues::getInstance()->getValues();
|
|
$ref_enums['TuneForCategory'] = AdSetTuneForCategoryValues::getInstance()->getValues();
|
|
$ref_enums['Operator'] = AdSetOperatorValues::getInstance()->getValues();
|
|
$ref_enums['StatusOption'] = AdSetStatusOptionValues::getInstance()->getValues();
|
|
return $ref_enums;
|
|
}
|
|
|
|
|
|
public function getActivities(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'after' => 'string',
|
|
'business_id' => 'string',
|
|
'category' => 'category_enum',
|
|
'limit' => 'int',
|
|
'since' => 'datetime',
|
|
'uid' => 'int',
|
|
'until' => 'datetime',
|
|
);
|
|
$enums = array(
|
|
'category_enum' => AdActivityCategoryValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/activities',
|
|
new AdActivity(),
|
|
'EDGE',
|
|
AdActivity::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getAdStudies(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,
|
|
'/ad_studies',
|
|
new AdStudy(),
|
|
'EDGE',
|
|
AdStudy::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getAdCreatives(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,
|
|
'/adcreatives',
|
|
new AdCreative(),
|
|
'EDGE',
|
|
AdCreative::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function deleteAdLabels(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'adlabels' => 'list<Object>',
|
|
'execution_options' => 'list<execution_options_enum>',
|
|
);
|
|
$enums = array(
|
|
'execution_options_enum' => AdSetExecutionOptionsValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_DELETE,
|
|
'/adlabels',
|
|
new AbstractCrudObject(),
|
|
'EDGE',
|
|
array(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function createAdLabel(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'adlabels' => 'list<Object>',
|
|
'execution_options' => 'list<execution_options_enum>',
|
|
);
|
|
$enums = array(
|
|
'execution_options_enum' => AdSetExecutionOptionsValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_POST,
|
|
'/adlabels',
|
|
new AdSet(),
|
|
'EDGE',
|
|
AdSet::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getAdRulesGoverned(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'pass_evaluation' => 'bool',
|
|
);
|
|
$enums = array(
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/adrules_governed',
|
|
new AdRule(),
|
|
'EDGE',
|
|
AdRule::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getAds(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'date_preset' => 'date_preset_enum',
|
|
'effective_status' => 'list<string>',
|
|
'time_range' => 'map',
|
|
'updated_since' => 'int',
|
|
);
|
|
$enums = array(
|
|
'date_preset_enum' => AdDatePresetValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/ads',
|
|
new Ad(),
|
|
'EDGE',
|
|
Ad::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getAsyncAdRequests(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'statuses' => 'list<statuses_enum>',
|
|
);
|
|
$enums = array(
|
|
'statuses_enum' => AdAsyncRequestStatusesValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/asyncadrequests',
|
|
new AdAsyncRequest(),
|
|
'EDGE',
|
|
AdAsyncRequest::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getBudgetSchedules(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'time_start' => 'datetime',
|
|
'time_stop' => 'datetime',
|
|
);
|
|
$enums = array(
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/budget_schedules',
|
|
new HighDemandPeriod(),
|
|
'EDGE',
|
|
HighDemandPeriod::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function createBudgetSchedule(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'budget_value' => 'unsigned int',
|
|
'budget_value_type' => 'budget_value_type_enum',
|
|
'time_end' => 'unsigned int',
|
|
'time_start' => 'unsigned int',
|
|
);
|
|
$enums = array(
|
|
'budget_value_type_enum' => HighDemandPeriodBudgetValueTypeValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_POST,
|
|
'/budget_schedules',
|
|
new HighDemandPeriod(),
|
|
'EDGE',
|
|
HighDemandPeriod::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getCopies(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'date_preset' => 'date_preset_enum',
|
|
'effective_status' => 'list<effective_status_enum>',
|
|
'is_completed' => 'bool',
|
|
'time_range' => 'map',
|
|
);
|
|
$enums = array(
|
|
'date_preset_enum' => AdSetDatePresetValues::getInstance()->getValues(),
|
|
'effective_status_enum' => AdSetEffectiveStatusValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/copies',
|
|
new AdSet(),
|
|
'EDGE',
|
|
AdSet::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function createCopy(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'campaign_id' => 'string',
|
|
'create_dco_adset' => 'bool',
|
|
'deep_copy' => 'bool',
|
|
'end_time' => 'datetime',
|
|
'rename_options' => 'Object',
|
|
'start_time' => 'datetime',
|
|
'status_option' => 'status_option_enum',
|
|
);
|
|
$enums = array(
|
|
'status_option_enum' => AdSetStatusOptionValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_POST,
|
|
'/copies',
|
|
new AdSet(),
|
|
'EDGE',
|
|
AdSet::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getDeliveryEstimate(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'optimization_goal' => 'optimization_goal_enum',
|
|
'promoted_object' => 'Object',
|
|
'targeting_spec' => 'Targeting',
|
|
);
|
|
$enums = array(
|
|
'optimization_goal_enum' => AdCampaignDeliveryEstimateOptimizationGoalValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/delivery_estimate',
|
|
new AdCampaignDeliveryEstimate(),
|
|
'EDGE',
|
|
AdCampaignDeliveryEstimate::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getInsights(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'action_attribution_windows' => 'list<action_attribution_windows_enum>',
|
|
'action_breakdowns' => 'list<action_breakdowns_enum>',
|
|
'action_report_time' => 'action_report_time_enum',
|
|
'breakdowns' => 'list<breakdowns_enum>',
|
|
'date_preset' => 'date_preset_enum',
|
|
'default_summary' => 'bool',
|
|
'export_columns' => 'list<string>',
|
|
'export_format' => 'string',
|
|
'export_name' => 'string',
|
|
'fields' => 'list<string>',
|
|
'filtering' => 'list<Object>',
|
|
'graph_cache' => 'bool',
|
|
'level' => 'level_enum',
|
|
'limit' => 'int',
|
|
'product_id_limit' => 'int',
|
|
'sort' => 'list<string>',
|
|
'summary' => 'list<string>',
|
|
'summary_action_breakdowns' => 'list<summary_action_breakdowns_enum>',
|
|
'time_increment' => 'string',
|
|
'time_range' => 'map',
|
|
'time_ranges' => 'list<map>',
|
|
'use_account_attribution_setting' => 'bool',
|
|
'use_unified_attribution_setting' => 'bool',
|
|
);
|
|
$enums = array(
|
|
'action_attribution_windows_enum' => AdsInsightsActionAttributionWindowsValues::getInstance()->getValues(),
|
|
'action_breakdowns_enum' => AdsInsightsActionBreakdownsValues::getInstance()->getValues(),
|
|
'action_report_time_enum' => AdsInsightsActionReportTimeValues::getInstance()->getValues(),
|
|
'breakdowns_enum' => AdsInsightsBreakdownsValues::getInstance()->getValues(),
|
|
'date_preset_enum' => AdsInsightsDatePresetValues::getInstance()->getValues(),
|
|
'level_enum' => AdsInsightsLevelValues::getInstance()->getValues(),
|
|
'summary_action_breakdowns_enum' => AdsInsightsSummaryActionBreakdownsValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/insights',
|
|
new AdsInsights(),
|
|
'EDGE',
|
|
AdsInsights::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getInsightsAsync(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'action_attribution_windows' => 'list<action_attribution_windows_enum>',
|
|
'action_breakdowns' => 'list<action_breakdowns_enum>',
|
|
'action_report_time' => 'action_report_time_enum',
|
|
'breakdowns' => 'list<breakdowns_enum>',
|
|
'date_preset' => 'date_preset_enum',
|
|
'default_summary' => 'bool',
|
|
'export_columns' => 'list<string>',
|
|
'export_format' => 'string',
|
|
'export_name' => 'string',
|
|
'fields' => 'list<string>',
|
|
'filtering' => 'list<Object>',
|
|
'graph_cache' => 'bool',
|
|
'level' => 'level_enum',
|
|
'limit' => 'int',
|
|
'product_id_limit' => 'int',
|
|
'sort' => 'list<string>',
|
|
'summary' => 'list<string>',
|
|
'summary_action_breakdowns' => 'list<summary_action_breakdowns_enum>',
|
|
'time_increment' => 'string',
|
|
'time_range' => 'map',
|
|
'time_ranges' => 'list<map>',
|
|
'use_account_attribution_setting' => 'bool',
|
|
'use_unified_attribution_setting' => 'bool',
|
|
);
|
|
$enums = array(
|
|
'action_attribution_windows_enum' => AdsInsightsActionAttributionWindowsValues::getInstance()->getValues(),
|
|
'action_breakdowns_enum' => AdsInsightsActionBreakdownsValues::getInstance()->getValues(),
|
|
'action_report_time_enum' => AdsInsightsActionReportTimeValues::getInstance()->getValues(),
|
|
'breakdowns_enum' => AdsInsightsBreakdownsValues::getInstance()->getValues(),
|
|
'date_preset_enum' => AdsInsightsDatePresetValues::getInstance()->getValues(),
|
|
'level_enum' => AdsInsightsLevelValues::getInstance()->getValues(),
|
|
'summary_action_breakdowns_enum' => AdsInsightsSummaryActionBreakdownsValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_POST,
|
|
'/insights',
|
|
new AdReportRun(),
|
|
'EDGE',
|
|
AdReportRun::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getMessageDeliveryEstimate(array $fields = array(), array $params = array(), $pending = false) {
|
|
$this->assureId();
|
|
|
|
$param_types = array(
|
|
'bid_amount' => 'unsigned int',
|
|
'daily_budget' => 'unsigned int',
|
|
'is_direct_send_campaign' => 'bool',
|
|
'lifetime_budget' => 'unsigned int',
|
|
'lifetime_in_days' => 'unsigned int',
|
|
'optimization_goal' => 'optimization_goal_enum',
|
|
'pacing_type' => 'pacing_type_enum',
|
|
'promoted_object' => 'Object',
|
|
'targeting_spec' => 'Targeting',
|
|
);
|
|
$enums = array(
|
|
'optimization_goal_enum' => MessageDeliveryEstimateOptimizationGoalValues::getInstance()->getValues(),
|
|
'pacing_type_enum' => MessageDeliveryEstimatePacingTypeValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/message_delivery_estimate',
|
|
new MessageDeliveryEstimate(),
|
|
'EDGE',
|
|
MessageDeliveryEstimate::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
public function getTargetingSentenceLines(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,
|
|
'/targetingsentencelines',
|
|
new TargetingSentenceLine(),
|
|
'EDGE',
|
|
TargetingSentenceLine::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(
|
|
'am_call_tags' => 'map',
|
|
'date_preset' => 'date_preset_enum',
|
|
'from_adtable' => 'bool',
|
|
'time_range' => 'map',
|
|
);
|
|
$enums = array(
|
|
'date_preset_enum' => array(
|
|
'data_maximum',
|
|
'last_14d',
|
|
'last_28d',
|
|
'last_30d',
|
|
'last_3d',
|
|
'last_7d',
|
|
'last_90d',
|
|
'last_month',
|
|
'last_quarter',
|
|
'last_week_mon_sun',
|
|
'last_week_sun_sat',
|
|
'last_year',
|
|
'maximum',
|
|
'this_month',
|
|
'this_quarter',
|
|
'this_week_mon_today',
|
|
'this_week_sun_today',
|
|
'this_year',
|
|
'today',
|
|
'yesterday',
|
|
),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_GET,
|
|
'/',
|
|
new AdSet(),
|
|
'NODE',
|
|
AdSet::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(
|
|
'account_id' => 'string',
|
|
'adlabels' => 'list<Object>',
|
|
'adset_schedule' => 'list<Object>',
|
|
'attribution_spec' => 'list<map>',
|
|
'automatic_manual_state' => 'automatic_manual_state_enum',
|
|
'bid_adjustments' => 'Object',
|
|
'bid_amount' => 'int',
|
|
'bid_constraints' => 'map<string, Object>',
|
|
'bid_strategy' => 'bid_strategy_enum',
|
|
'billing_event' => 'billing_event_enum',
|
|
'budget_schedule_specs' => 'list<Object>',
|
|
'campaign_attribution' => 'Object',
|
|
'campaign_spec' => 'Object',
|
|
'creative_sequence' => 'list<string>',
|
|
'creative_sequence_repetition_pattern' => 'creative_sequence_repetition_pattern_enum',
|
|
'daily_budget' => 'unsigned int',
|
|
'daily_imps' => 'unsigned int',
|
|
'daily_min_spend_target' => 'unsigned int',
|
|
'daily_spend_cap' => 'unsigned int',
|
|
'date_format' => 'string',
|
|
'destination_type' => 'destination_type_enum',
|
|
'dsa_beneficiary' => 'string',
|
|
'dsa_payor' => 'string',
|
|
'end_time' => 'datetime',
|
|
'execution_options' => 'list<execution_options_enum>',
|
|
'existing_customer_budget_percentage' => 'unsigned int',
|
|
'full_funnel_exploration_mode' => 'full_funnel_exploration_mode_enum',
|
|
'is_ba_skip_delayed_eligible' => 'bool',
|
|
'is_budget_schedule_enabled' => 'bool',
|
|
'is_incremental_attribution_enabled' => 'bool',
|
|
'is_sac_cfca_terms_certified' => 'bool',
|
|
'lifetime_budget' => 'unsigned int',
|
|
'lifetime_imps' => 'unsigned int',
|
|
'lifetime_min_spend_target' => 'unsigned int',
|
|
'lifetime_spend_cap' => 'unsigned int',
|
|
'max_budget_spend_percentage' => 'unsigned int',
|
|
'min_budget_spend_percentage' => 'unsigned int',
|
|
'multi_optimization_goal_weight' => 'multi_optimization_goal_weight_enum',
|
|
'name' => 'string',
|
|
'optimization_goal' => 'optimization_goal_enum',
|
|
'optimization_sub_event' => 'optimization_sub_event_enum',
|
|
'pacing_type' => 'list<string>',
|
|
'promoted_object' => 'Object',
|
|
'rb_prediction_id' => 'string',
|
|
'regional_regulated_categories' => 'list<regional_regulated_categories_enum>',
|
|
'regional_regulation_identities' => 'map',
|
|
'rf_prediction_id' => 'string',
|
|
'start_time' => 'datetime',
|
|
'status' => 'status_enum',
|
|
'targeting' => 'Targeting',
|
|
'time_based_ad_rotation_id_blocks' => 'list<list<unsigned int>>',
|
|
'time_based_ad_rotation_intervals' => 'list<unsigned int>',
|
|
'time_start' => 'datetime',
|
|
'time_stop' => 'datetime',
|
|
'trending_topics_spec' => 'map',
|
|
'tune_for_category' => 'tune_for_category_enum',
|
|
'value_rule_set_id' => 'string',
|
|
'value_rules_applied' => 'bool',
|
|
);
|
|
$enums = array(
|
|
'automatic_manual_state_enum' => AdSetAutomaticManualStateValues::getInstance()->getValues(),
|
|
'bid_strategy_enum' => AdSetBidStrategyValues::getInstance()->getValues(),
|
|
'billing_event_enum' => AdSetBillingEventValues::getInstance()->getValues(),
|
|
'creative_sequence_repetition_pattern_enum' => AdSetCreativeSequenceRepetitionPatternValues::getInstance()->getValues(),
|
|
'destination_type_enum' => AdSetDestinationTypeValues::getInstance()->getValues(),
|
|
'execution_options_enum' => AdSetExecutionOptionsValues::getInstance()->getValues(),
|
|
'full_funnel_exploration_mode_enum' => AdSetFullFunnelExplorationModeValues::getInstance()->getValues(),
|
|
'multi_optimization_goal_weight_enum' => AdSetMultiOptimizationGoalWeightValues::getInstance()->getValues(),
|
|
'optimization_goal_enum' => AdSetOptimizationGoalValues::getInstance()->getValues(),
|
|
'optimization_sub_event_enum' => AdSetOptimizationSubEventValues::getInstance()->getValues(),
|
|
'regional_regulated_categories_enum' => AdSetRegionalRegulatedCategoriesValues::getInstance()->getValues(),
|
|
'status_enum' => AdSetStatusValues::getInstance()->getValues(),
|
|
'tune_for_category_enum' => AdSetTuneForCategoryValues::getInstance()->getValues(),
|
|
);
|
|
|
|
$request = new ApiRequest(
|
|
$this->api,
|
|
$this->data['id'],
|
|
RequestInterface::METHOD_POST,
|
|
'/',
|
|
new AdSet(),
|
|
'NODE',
|
|
AdSet::getFieldsEnum()->getValues(),
|
|
new TypeChecker($param_types, $enums)
|
|
);
|
|
$request->addParams($params);
|
|
$request->addFields($fields);
|
|
return $pending ? $request : $request->execute();
|
|
}
|
|
|
|
}
|