Complex classes like AdAccount often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use AdAccount, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 87 | class AdAccount extends AbstractCrudObject { |
||
| 88 | |||
| 89 | /** |
||
| 90 | * @deprecated getEndpoint function is deprecated |
||
| 91 | */ |
||
| 92 | protected function getEndpoint() { |
||
| 93 | return 'adaccounts'; |
||
| 94 | } |
||
| 95 | |||
| 96 | /** |
||
| 97 | * @return AdAccountFields |
||
| 98 | */ |
||
| 99 | public static function getFieldsEnum() { |
||
| 100 | return AdAccountFields::getInstance(); |
||
| 101 | } |
||
| 102 | |||
| 103 | protected static function getReferencedEnums() { |
||
| 104 | $ref_enums = array(); |
||
| 105 | $ref_enums['AccessType'] = AdAccountAccessTypeValues::getInstance()->getValues(); |
||
| 106 | $ref_enums['PermittedRoles'] = AdAccountPermittedRolesValues::getInstance()->getValues(); |
||
| 107 | return $ref_enums; |
||
| 108 | } |
||
| 109 | |||
| 110 | |||
| 111 | public function getActivities(array $fields = array(), array $params = array(), $pending = false) { |
||
| 112 | $this->assureId(); |
||
| 113 | |||
| 114 | $param_types = array( |
||
| 115 | 'add_children' => 'bool', |
||
| 116 | 'business_id' => 'string', |
||
| 117 | 'category' => 'category_enum', |
||
| 118 | 'extra_oids' => 'list<string>', |
||
| 119 | 'oid' => 'string', |
||
| 120 | 'since' => 'datetime', |
||
| 121 | 'uid' => 'int', |
||
| 122 | 'until' => 'datetime', |
||
| 123 | ); |
||
| 124 | $enums = array( |
||
| 125 | 'category_enum' => AdActivityCategoryValues::getInstance()->getValues(), |
||
| 126 | ); |
||
| 127 | |||
| 128 | $request = new ApiRequest( |
||
| 129 | $this->api, |
||
| 130 | $this->data['id'], |
||
| 131 | RequestInterface::METHOD_GET, |
||
| 132 | '/activities', |
||
| 133 | new AdActivity(), |
||
| 134 | 'EDGE', |
||
| 135 | AdActivity::getFieldsEnum()->getValues(), |
||
| 136 | new TypeChecker($param_types, $enums) |
||
| 137 | ); |
||
| 138 | $request->addParams($params); |
||
| 139 | $request->addFields($fields); |
||
| 140 | return $pending ? $request : $request->execute(); |
||
| 141 | } |
||
| 142 | |||
| 143 | public function getAdPlacePageSets(array $fields = array(), array $params = array(), $pending = false) { |
||
| 144 | $this->assureId(); |
||
| 145 | |||
| 146 | $param_types = array( |
||
| 147 | ); |
||
| 148 | $enums = array( |
||
| 149 | ); |
||
| 150 | |||
| 151 | $request = new ApiRequest( |
||
| 152 | $this->api, |
||
| 153 | $this->data['id'], |
||
| 154 | RequestInterface::METHOD_GET, |
||
| 155 | '/ad_place_page_sets', |
||
| 156 | new AdPlacePageSet(), |
||
| 157 | 'EDGE', |
||
| 158 | AdPlacePageSet::getFieldsEnum()->getValues(), |
||
| 159 | new TypeChecker($param_types, $enums) |
||
| 160 | ); |
||
| 161 | $request->addParams($params); |
||
| 162 | $request->addFields($fields); |
||
| 163 | return $pending ? $request : $request->execute(); |
||
| 164 | } |
||
| 165 | |||
| 166 | public function createAdPlacePageSet(array $fields = array(), array $params = array(), $pending = false) { |
||
| 167 | $this->assureId(); |
||
| 168 | |||
| 169 | $param_types = array( |
||
| 170 | 'location_types' => 'list<location_types_enum>', |
||
| 171 | 'name' => 'string', |
||
| 172 | 'parent_page' => 'string', |
||
| 173 | ); |
||
| 174 | $enums = array( |
||
| 175 | 'location_types_enum' => AdPlacePageSetLocationTypesValues::getInstance()->getValues(), |
||
| 176 | ); |
||
| 177 | |||
| 178 | $request = new ApiRequest( |
||
| 179 | $this->api, |
||
| 180 | $this->data['id'], |
||
| 181 | RequestInterface::METHOD_POST, |
||
| 182 | '/ad_place_page_sets', |
||
| 183 | new AdPlacePageSet(), |
||
| 184 | 'EDGE', |
||
| 185 | AdPlacePageSet::getFieldsEnum()->getValues(), |
||
| 186 | new TypeChecker($param_types, $enums) |
||
| 187 | ); |
||
| 188 | $request->addParams($params); |
||
| 189 | $request->addFields($fields); |
||
| 190 | return $pending ? $request : $request->execute(); |
||
| 191 | } |
||
| 192 | |||
| 193 | public function getAdCreatives(array $fields = array(), array $params = array(), $pending = false) { |
||
| 194 | $this->assureId(); |
||
| 195 | |||
| 196 | $param_types = array( |
||
| 197 | ); |
||
| 198 | $enums = array( |
||
| 199 | ); |
||
| 200 | |||
| 201 | $request = new ApiRequest( |
||
| 202 | $this->api, |
||
| 203 | $this->data['id'], |
||
| 204 | RequestInterface::METHOD_GET, |
||
| 205 | '/adcreatives', |
||
| 206 | new AdCreative(), |
||
| 207 | 'EDGE', |
||
| 208 | AdCreative::getFieldsEnum()->getValues(), |
||
| 209 | new TypeChecker($param_types, $enums) |
||
| 210 | ); |
||
| 211 | $request->addParams($params); |
||
| 212 | $request->addFields($fields); |
||
| 213 | return $pending ? $request : $request->execute(); |
||
| 214 | } |
||
| 215 | |||
| 216 | public function createAdCreative(array $fields = array(), array $params = array(), $pending = false) { |
||
| 217 | $this->assureId(); |
||
| 218 | |||
| 219 | $param_types = array( |
||
| 220 | 'actor_id' => 'unsigned int', |
||
| 221 | 'adlabels' => 'list<Object>', |
||
| 222 | 'applink_treatment' => 'applink_treatment_enum', |
||
| 223 | 'body' => 'string', |
||
| 224 | 'call_to_action' => 'Object', |
||
| 225 | 'dynamic_ad_voice' => 'dynamic_ad_voice_enum', |
||
| 226 | 'image_crops' => 'map', |
||
| 227 | 'image_file' => 'string', |
||
| 228 | 'image_hash' => 'string', |
||
| 229 | 'image_url' => 'string', |
||
| 230 | 'instagram_actor_id' => 'string', |
||
| 231 | 'instagram_permalink_url' => 'string', |
||
| 232 | 'instagram_story_id' => 'unsigned int', |
||
| 233 | 'link_og_id' => 'string', |
||
| 234 | 'link_url' => 'string', |
||
| 235 | 'name' => 'string', |
||
| 236 | 'object_id' => 'unsigned int', |
||
| 237 | 'object_story_id' => 'string', |
||
| 238 | 'object_story_spec' => 'AdCreativeObjectStorySpec', |
||
| 239 | 'object_type' => 'string', |
||
| 240 | 'object_url' => 'string', |
||
| 241 | 'platform_customizations' => 'Object', |
||
| 242 | 'product_set_id' => 'string', |
||
| 243 | 'template_url' => 'string', |
||
| 244 | 'template_url_spec' => 'Object', |
||
| 245 | 'thumbnail_url' => 'string', |
||
| 246 | 'title' => 'string', |
||
| 247 | 'url_tags' => 'string', |
||
| 248 | 'use_page_actor_override' => 'bool', |
||
| 249 | ); |
||
| 250 | $enums = array( |
||
| 251 | 'applink_treatment_enum' => AdCreativeApplinkTreatmentValues::getInstance()->getValues(), |
||
| 252 | 'dynamic_ad_voice_enum' => AdCreativeDynamicAdVoiceValues::getInstance()->getValues(), |
||
| 253 | ); |
||
| 254 | |||
| 255 | $request = new ApiRequest( |
||
| 256 | $this->api, |
||
| 257 | $this->data['id'], |
||
| 258 | RequestInterface::METHOD_POST, |
||
| 259 | '/adcreatives', |
||
| 260 | new AdCreative(), |
||
| 261 | 'EDGE', |
||
| 262 | AdCreative::getFieldsEnum()->getValues(), |
||
| 263 | new TypeChecker($param_types, $enums) |
||
| 264 | ); |
||
| 265 | $request->addParams($params); |
||
| 266 | $request->addFields($fields); |
||
| 267 | return $pending ? $request : $request->execute(); |
||
| 268 | } |
||
| 269 | |||
| 270 | public function getAdCreativesByLabels(array $fields = array(), array $params = array(), $pending = false) { |
||
| 271 | $this->assureId(); |
||
| 272 | |||
| 273 | $param_types = array( |
||
| 274 | 'ad_label_ids' => 'list<string>', |
||
| 275 | 'operator' => 'operator_enum', |
||
| 276 | ); |
||
| 277 | $enums = array( |
||
| 278 | 'operator_enum' => AdCreativeOperatorValues::getInstance()->getValues(), |
||
| 279 | ); |
||
| 280 | |||
| 281 | $request = new ApiRequest( |
||
| 282 | $this->api, |
||
| 283 | $this->data['id'], |
||
| 284 | RequestInterface::METHOD_GET, |
||
| 285 | '/adcreativesbylabels', |
||
| 286 | new AdCreative(), |
||
| 287 | 'EDGE', |
||
| 288 | AdCreative::getFieldsEnum()->getValues(), |
||
| 289 | new TypeChecker($param_types, $enums) |
||
| 290 | ); |
||
| 291 | $request->addParams($params); |
||
| 292 | $request->addFields($fields); |
||
| 293 | return $pending ? $request : $request->execute(); |
||
| 294 | } |
||
| 295 | |||
| 296 | public function deleteAdImages(array $fields = array(), array $params = array(), $pending = false) { |
||
| 297 | $this->assureId(); |
||
| 298 | |||
| 299 | $param_types = array( |
||
| 300 | 'hash' => 'string', |
||
| 301 | ); |
||
| 302 | $enums = array( |
||
| 303 | ); |
||
| 304 | |||
| 305 | $request = new ApiRequest( |
||
| 306 | $this->api, |
||
| 307 | $this->data['id'], |
||
| 308 | RequestInterface::METHOD_DELETE, |
||
| 309 | '/adimages', |
||
| 310 | new AbstractCrudObject(), |
||
| 311 | 'EDGE', |
||
| 312 | array(), |
||
| 313 | new TypeChecker($param_types, $enums) |
||
| 314 | ); |
||
| 315 | $request->addParams($params); |
||
| 316 | $request->addFields($fields); |
||
| 317 | return $pending ? $request : $request->execute(); |
||
| 318 | } |
||
| 319 | |||
| 320 | public function getAdImages(array $fields = array(), array $params = array(), $pending = false) { |
||
| 321 | $this->assureId(); |
||
| 322 | |||
| 323 | $param_types = array( |
||
| 324 | 'biz_tag_id' => 'unsigned int', |
||
| 325 | 'business_id' => 'string', |
||
| 326 | 'hashes' => 'list<string>', |
||
| 327 | 'minheight' => 'unsigned int', |
||
| 328 | 'minwidth' => 'unsigned int', |
||
| 329 | 'name' => 'string', |
||
| 330 | ); |
||
| 331 | $enums = array( |
||
| 332 | ); |
||
| 333 | |||
| 334 | $request = new ApiRequest( |
||
| 335 | $this->api, |
||
| 336 | $this->data['id'], |
||
| 337 | RequestInterface::METHOD_GET, |
||
| 338 | '/adimages', |
||
| 339 | new AdImage(), |
||
| 340 | 'EDGE', |
||
| 341 | AdImage::getFieldsEnum()->getValues(), |
||
| 342 | new TypeChecker($param_types, $enums) |
||
| 343 | ); |
||
| 344 | $request->addParams($params); |
||
| 345 | $request->addFields($fields); |
||
| 346 | return $pending ? $request : $request->execute(); |
||
| 347 | } |
||
| 348 | |||
| 349 | public function createAdImage(array $fields = array(), array $params = array(), $pending = false) { |
||
| 350 | $this->assureId(); |
||
| 351 | |||
| 352 | $param_types = array( |
||
| 353 | 'bytes' => 'Object', |
||
| 354 | 'copy_from' => 'Object', |
||
| 355 | 'zipbytes' => 'Object', |
||
| 356 | ); |
||
| 357 | $enums = array( |
||
| 358 | ); |
||
| 359 | |||
| 360 | $request = new ApiRequest( |
||
| 361 | $this->api, |
||
| 362 | $this->data['id'], |
||
| 363 | RequestInterface::METHOD_POST, |
||
| 364 | '/adimages', |
||
| 365 | new AdImage(), |
||
| 366 | 'EDGE', |
||
| 367 | AdImage::getFieldsEnum()->getValues(), |
||
| 368 | new TypeChecker($param_types, $enums), |
||
| 369 | true |
||
| 370 | ); |
||
| 371 | $request->addParams($params); |
||
| 372 | $request->addFields($fields); |
||
| 373 | return $pending ? $request : $request->execute(); |
||
| 374 | } |
||
| 375 | |||
| 376 | public function getAdLabels(array $fields = array(), array $params = array(), $pending = false) { |
||
| 377 | $this->assureId(); |
||
| 378 | |||
| 379 | $param_types = array( |
||
| 380 | ); |
||
| 381 | $enums = array( |
||
| 382 | ); |
||
| 383 | |||
| 384 | $request = new ApiRequest( |
||
| 385 | $this->api, |
||
| 386 | $this->data['id'], |
||
| 387 | RequestInterface::METHOD_GET, |
||
| 388 | '/adlabels', |
||
| 389 | new AdLabel(), |
||
| 390 | 'EDGE', |
||
| 391 | AdLabel::getFieldsEnum()->getValues(), |
||
| 392 | new TypeChecker($param_types, $enums) |
||
| 393 | ); |
||
| 394 | $request->addParams($params); |
||
| 395 | $request->addFields($fields); |
||
| 396 | return $pending ? $request : $request->execute(); |
||
| 397 | } |
||
| 398 | |||
| 399 | public function createAdLabel(array $fields = array(), array $params = array(), $pending = false) { |
||
| 400 | $this->assureId(); |
||
| 401 | |||
| 402 | $param_types = array( |
||
| 403 | 'name' => 'string', |
||
| 404 | ); |
||
| 405 | $enums = array( |
||
| 406 | ); |
||
| 407 | |||
| 408 | $request = new ApiRequest( |
||
| 409 | $this->api, |
||
| 410 | $this->data['id'], |
||
| 411 | RequestInterface::METHOD_POST, |
||
| 412 | '/adlabels', |
||
| 413 | new AdLabel(), |
||
| 414 | 'EDGE', |
||
| 415 | AdLabel::getFieldsEnum()->getValues(), |
||
| 416 | new TypeChecker($param_types, $enums) |
||
| 417 | ); |
||
| 418 | $request->addParams($params); |
||
| 419 | $request->addFields($fields); |
||
| 420 | return $pending ? $request : $request->execute(); |
||
| 421 | } |
||
| 422 | |||
| 423 | public function getAdReportRuns(array $fields = array(), array $params = array(), $pending = false) { |
||
| 424 | $this->assureId(); |
||
| 425 | |||
| 426 | $param_types = array( |
||
| 427 | ); |
||
| 428 | $enums = array( |
||
| 429 | ); |
||
| 430 | |||
| 431 | $request = new ApiRequest( |
||
| 432 | $this->api, |
||
| 433 | $this->data['id'], |
||
| 434 | RequestInterface::METHOD_GET, |
||
| 435 | '/adreportruns', |
||
| 436 | new AdReportRun(), |
||
| 437 | 'EDGE', |
||
| 438 | AdReportRun::getFieldsEnum()->getValues(), |
||
| 439 | new TypeChecker($param_types, $enums) |
||
| 440 | ); |
||
| 441 | $request->addParams($params); |
||
| 442 | $request->addFields($fields); |
||
| 443 | return $pending ? $request : $request->execute(); |
||
| 444 | } |
||
| 445 | |||
| 446 | public function getAdReportSchedules(array $fields = array(), array $params = array(), $pending = false) { |
||
| 447 | $this->assureId(); |
||
| 448 | |||
| 449 | $param_types = array( |
||
| 450 | ); |
||
| 451 | $enums = array( |
||
| 452 | ); |
||
| 453 | |||
| 454 | $request = new ApiRequest( |
||
| 455 | $this->api, |
||
| 456 | $this->data['id'], |
||
| 457 | RequestInterface::METHOD_GET, |
||
| 458 | '/adreportschedules', |
||
| 459 | new AbstractCrudObject(), |
||
| 460 | 'EDGE', |
||
| 461 | array(), |
||
| 462 | new TypeChecker($param_types, $enums) |
||
| 463 | ); |
||
| 464 | $request->addParams($params); |
||
| 465 | $request->addFields($fields); |
||
| 466 | return $pending ? $request : $request->execute(); |
||
| 467 | } |
||
| 468 | |||
| 469 | public function getAds(array $fields = array(), array $params = array(), $pending = false) { |
||
| 470 | $this->assureId(); |
||
| 471 | |||
| 472 | $param_types = array( |
||
| 473 | 'ad_draft_id' => 'string', |
||
| 474 | 'date_preset' => 'date_preset_enum', |
||
| 475 | 'effective_status' => 'list<string>', |
||
| 476 | 'include_deleted' => 'bool', |
||
| 477 | 'time_range' => 'Object', |
||
| 478 | 'updated_since' => 'int', |
||
| 479 | ); |
||
| 480 | $enums = array( |
||
| 481 | 'date_preset_enum' => AdDatePresetValues::getInstance()->getValues(), |
||
| 482 | ); |
||
| 483 | |||
| 484 | $request = new ApiRequest( |
||
| 485 | $this->api, |
||
| 486 | $this->data['id'], |
||
| 487 | RequestInterface::METHOD_GET, |
||
| 488 | '/ads', |
||
| 489 | new Ad(), |
||
| 490 | 'EDGE', |
||
| 491 | Ad::getFieldsEnum()->getValues(), |
||
| 492 | new TypeChecker($param_types, $enums) |
||
| 493 | ); |
||
| 494 | $request->addParams($params); |
||
| 495 | $request->addFields($fields); |
||
| 496 | return $pending ? $request : $request->execute(); |
||
| 497 | } |
||
| 498 | |||
| 499 | public function createAd(array $fields = array(), array $params = array(), $pending = false) { |
||
| 500 | $this->assureId(); |
||
| 501 | |||
| 502 | $param_types = array( |
||
| 503 | 'adlabels' => 'list<Object>', |
||
| 504 | 'adset_id' => 'unsigned int', |
||
| 505 | 'adset_spec' => 'AdSet', |
||
| 506 | 'bid_amount' => 'int', |
||
| 507 | 'creative' => 'AdCreative', |
||
| 508 | 'date_format' => 'string', |
||
| 509 | 'display_sequence' => 'unsigned int', |
||
| 510 | 'execution_options' => 'list<execution_options_enum>', |
||
| 511 | 'name' => 'string', |
||
| 512 | 'redownload' => 'bool', |
||
| 513 | 'status' => 'status_enum', |
||
| 514 | 'tracking_specs' => 'Object', |
||
| 515 | ); |
||
| 516 | $enums = array( |
||
| 517 | 'execution_options_enum' => AdExecutionOptionsValues::getInstance()->getValues(), |
||
| 518 | 'status_enum' => AdStatusValues::getInstance()->getValues(), |
||
| 519 | ); |
||
| 520 | |||
| 521 | $request = new ApiRequest( |
||
| 522 | $this->api, |
||
| 523 | $this->data['id'], |
||
| 524 | RequestInterface::METHOD_POST, |
||
| 525 | '/ads', |
||
| 526 | new Ad(), |
||
| 527 | 'EDGE', |
||
| 528 | Ad::getFieldsEnum()->getValues(), |
||
| 529 | new TypeChecker($param_types, $enums), |
||
| 530 | true |
||
| 531 | ); |
||
| 532 | $request->addParams($params); |
||
| 533 | $request->addFields($fields); |
||
| 534 | return $pending ? $request : $request->execute(); |
||
| 535 | } |
||
| 536 | |||
| 537 | public function getAdsByLabels(array $fields = array(), array $params = array(), $pending = false) { |
||
| 538 | $this->assureId(); |
||
| 539 | |||
| 540 | $param_types = array( |
||
| 541 | 'ad_label_ids' => 'list<string>', |
||
| 542 | 'operator' => 'operator_enum', |
||
| 543 | ); |
||
| 544 | $enums = array( |
||
| 545 | 'operator_enum' => AdOperatorValues::getInstance()->getValues(), |
||
| 546 | ); |
||
| 547 | |||
| 548 | $request = new ApiRequest( |
||
| 549 | $this->api, |
||
| 550 | $this->data['id'], |
||
| 551 | RequestInterface::METHOD_GET, |
||
| 552 | '/adsbylabels', |
||
| 553 | new Ad(), |
||
| 554 | 'EDGE', |
||
| 555 | Ad::getFieldsEnum()->getValues(), |
||
| 556 | new TypeChecker($param_types, $enums) |
||
| 557 | ); |
||
| 558 | $request->addParams($params); |
||
| 559 | $request->addFields($fields); |
||
| 560 | return $pending ? $request : $request->execute(); |
||
| 561 | } |
||
| 562 | |||
| 563 | public function getAdSets(array $fields = array(), array $params = array(), $pending = false) { |
||
| 564 | $this->assureId(); |
||
| 565 | |||
| 566 | $param_types = array( |
||
| 567 | 'ad_draft_id' => 'string', |
||
| 568 | 'date_preset' => 'date_preset_enum', |
||
| 569 | 'effective_status' => 'list<effective_status_enum>', |
||
| 570 | 'include_deleted' => 'bool', |
||
| 571 | 'is_completed' => 'bool', |
||
| 572 | 'time_range' => 'Object', |
||
| 573 | ); |
||
| 574 | $enums = array( |
||
| 575 | 'date_preset_enum' => AdSetDatePresetValues::getInstance()->getValues(), |
||
| 576 | 'effective_status_enum' => AdSetEffectiveStatusValues::getInstance()->getValues(), |
||
| 577 | ); |
||
| 578 | |||
| 579 | $request = new ApiRequest( |
||
| 580 | $this->api, |
||
| 581 | $this->data['id'], |
||
| 582 | RequestInterface::METHOD_GET, |
||
| 583 | '/adsets', |
||
| 584 | new AdSet(), |
||
| 585 | 'EDGE', |
||
| 586 | AdSet::getFieldsEnum()->getValues(), |
||
| 587 | new TypeChecker($param_types, $enums) |
||
| 588 | ); |
||
| 589 | $request->addParams($params); |
||
| 590 | $request->addFields($fields); |
||
| 591 | return $pending ? $request : $request->execute(); |
||
| 592 | } |
||
| 593 | |||
| 594 | public function createAdSet(array $fields = array(), array $params = array(), $pending = false) { |
||
| 595 | $this->assureId(); |
||
| 596 | |||
| 597 | $param_types = array( |
||
| 598 | 'adlabels' => 'list<Object>', |
||
| 599 | 'adset_schedule' => 'list<Object>', |
||
| 600 | 'attribution_spec' => 'list<map>', |
||
| 601 | 'bid_amount' => 'int', |
||
| 602 | 'billing_event' => 'billing_event_enum', |
||
| 603 | 'campaign_id' => 'string', |
||
| 604 | 'campaign_spec' => 'Object', |
||
| 605 | 'creative_sequence' => 'list<string>', |
||
| 606 | 'daily_budget' => 'unsigned int', |
||
| 607 | 'daily_imps' => 'unsigned int', |
||
| 608 | 'end_time' => 'datetime', |
||
| 609 | 'execution_options' => 'list<execution_options_enum>', |
||
| 610 | 'frequency_control_specs' => 'list<Object>', |
||
| 611 | 'is_autobid' => 'bool', |
||
| 612 | 'is_average_price_pacing' => 'bool', |
||
| 613 | 'lifetime_budget' => 'unsigned int', |
||
| 614 | 'lifetime_imps' => 'unsigned int', |
||
| 615 | 'name' => 'string', |
||
| 616 | 'optimization_goal' => 'optimization_goal_enum', |
||
| 617 | 'pacing_type' => 'list<string>', |
||
| 618 | 'promoted_object' => 'Object', |
||
| 619 | 'redownload' => 'bool', |
||
| 620 | 'rf_prediction_id' => 'string', |
||
| 621 | 'start_time' => 'datetime', |
||
| 622 | 'status' => 'status_enum', |
||
| 623 | 'targeting' => 'Targeting', |
||
| 624 | 'time_based_ad_rotation_id_blocks' => 'list<list<unsigned int>>', |
||
| 625 | 'time_based_ad_rotation_intervals' => 'list<unsigned int>', |
||
| 626 | ); |
||
| 627 | $enums = array( |
||
| 628 | 'billing_event_enum' => AdSetBillingEventValues::getInstance()->getValues(), |
||
| 629 | 'execution_options_enum' => AdSetExecutionOptionsValues::getInstance()->getValues(), |
||
| 630 | 'optimization_goal_enum' => AdSetOptimizationGoalValues::getInstance()->getValues(), |
||
| 631 | 'status_enum' => AdSetStatusValues::getInstance()->getValues(), |
||
| 632 | ); |
||
| 633 | |||
| 634 | $request = new ApiRequest( |
||
| 635 | $this->api, |
||
| 636 | $this->data['id'], |
||
| 637 | RequestInterface::METHOD_POST, |
||
| 638 | '/adsets', |
||
| 639 | new AdSet(), |
||
| 640 | 'EDGE', |
||
| 641 | AdSet::getFieldsEnum()->getValues(), |
||
| 642 | new TypeChecker($param_types, $enums) |
||
| 643 | ); |
||
| 644 | $request->addParams($params); |
||
| 645 | $request->addFields($fields); |
||
| 646 | return $pending ? $request : $request->execute(); |
||
| 647 | } |
||
| 648 | |||
| 649 | public function getAdSetsByLabels(array $fields = array(), array $params = array(), $pending = false) { |
||
| 674 | |||
| 675 | public function getAdsPixels(array $fields = array(), array $params = array(), $pending = false) { |
||
| 697 | |||
| 698 | public function createAdsPixel(array $fields = array(), array $params = array(), $pending = false) { |
||
| 721 | |||
| 722 | public function getAdvertisableApplications(array $fields = array(), array $params = array(), $pending = false) { |
||
| 746 | |||
| 747 | public function getAdVideos(array $fields = array(), array $params = array(), $pending = false) { |
||
| 769 | |||
| 770 | public function createAdVideo(array $fields = array(), array $params = array(), $pending = false) { |
||
| 771 | $this->assureId(); |
||
| 772 | |||
| 773 | $param_types = array( |
||
| 774 | 'composer_session_id' => 'string', |
||
| 775 | 'description' => 'string', |
||
| 776 | 'file_size' => 'unsigned int', |
||
| 777 | 'file_url' => 'string', |
||
| 778 | 'is_explicit_share' => 'bool', |
||
| 779 | 'manual_privacy' => 'bool', |
||
| 780 | 'name' => 'string', |
||
| 781 | 'og_action_type_id' => 'string', |
||
| 782 | 'og_icon_id' => 'string', |
||
| 783 | 'og_object_id' => 'string', |
||
| 784 | 'og_phrase' => 'string', |
||
| 785 | 'og_suggestion_mechanism' => 'string', |
||
| 786 | 'original_fov' => 'unsigned int', |
||
| 787 | 'original_projection_type' => 'original_projection_type_enum', |
||
| 788 | 'referenced_sticker_id' => 'string', |
||
| 789 | 'slideshow_spec' => 'map', |
||
| 790 | 'start_offset' => 'unsigned int', |
||
| 791 | 'time_since_original_post' => 'unsigned int', |
||
| 792 | 'title' => 'string', |
||
| 793 | 'unpublished_content_type' => 'unpublished_content_type_enum', |
||
| 794 | 'upload_phase' => 'upload_phase_enum', |
||
| 795 | 'upload_session_id' => 'string', |
||
| 796 | 'video_file_chunk' => 'string', |
||
| 797 | ); |
||
| 798 | $enums = array( |
||
| 799 | 'original_projection_type_enum' => array( |
||
| 800 | 'equirectangular', |
||
| 801 | 'cubemap', |
||
| 802 | ), |
||
| 803 | 'unpublished_content_type_enum' => array( |
||
| 804 | 'SCHEDULED', |
||
| 805 | 'DRAFT', |
||
| 806 | 'ADS_POST', |
||
| 807 | ), |
||
| 808 | 'upload_phase_enum' => array( |
||
| 809 | 'start', |
||
| 810 | 'transfer', |
||
| 811 | 'finish', |
||
| 812 | 'cancel', |
||
| 813 | ), |
||
| 814 | ); |
||
| 815 | |||
| 816 | $request = new ApiRequest( |
||
| 817 | $this->api, |
||
| 818 | $this->data['id'], |
||
| 819 | RequestInterface::METHOD_POST, |
||
| 820 | '/advideos', |
||
| 821 | new AbstractCrudObject(), |
||
| 822 | 'EDGE', |
||
| 823 | array(), |
||
| 824 | new TypeChecker($param_types, $enums), |
||
| 825 | true, |
||
| 826 | true |
||
| 827 | ); |
||
| 828 | $request->addParams($params); |
||
| 829 | $request->addFields($fields); |
||
| 830 | return $pending ? $request : $request->execute(); |
||
| 831 | } |
||
| 832 | |||
| 833 | public function getApplications(array $fields = array(), array $params = array(), $pending = false) { |
||
| 834 | $this->assureId(); |
||
| 835 | |||
| 836 | $param_types = array( |
||
| 837 | ); |
||
| 838 | $enums = array( |
||
| 839 | ); |
||
| 840 | |||
| 841 | $request = new ApiRequest( |
||
| 842 | $this->api, |
||
| 843 | $this->data['id'], |
||
| 844 | RequestInterface::METHOD_GET, |
||
| 845 | '/applications', |
||
| 846 | new AbstractCrudObject(), |
||
| 847 | 'EDGE', |
||
| 848 | array(), |
||
| 849 | new TypeChecker($param_types, $enums) |
||
| 850 | ); |
||
| 851 | $request->addParams($params); |
||
| 852 | $request->addFields($fields); |
||
| 853 | return $pending ? $request : $request->execute(); |
||
| 854 | } |
||
| 855 | |||
| 856 | public function getAsyncAdRequestSets(array $fields = array(), array $params = array(), $pending = false) { |
||
| 857 | $this->assureId(); |
||
| 858 | |||
| 859 | $param_types = array( |
||
| 860 | 'is_completed' => 'bool', |
||
| 861 | ); |
||
| 862 | $enums = array( |
||
| 863 | ); |
||
| 864 | |||
| 865 | $request = new ApiRequest( |
||
| 866 | $this->api, |
||
| 867 | $this->data['id'], |
||
| 868 | RequestInterface::METHOD_GET, |
||
| 869 | '/asyncadrequestsets', |
||
| 870 | new AdAsyncRequestSet(), |
||
| 871 | 'EDGE', |
||
| 872 | AdAsyncRequestSet::getFieldsEnum()->getValues(), |
||
| 873 | new TypeChecker($param_types, $enums) |
||
| 874 | ); |
||
| 875 | $request->addParams($params); |
||
| 876 | $request->addFields($fields); |
||
| 877 | return $pending ? $request : $request->execute(); |
||
| 878 | } |
||
| 879 | |||
| 880 | public function createAsyncAdRequestSet(array $fields = array(), array $params = array(), $pending = false) { |
||
| 881 | $this->assureId(); |
||
| 882 | |||
| 883 | $param_types = array( |
||
| 884 | 'ad_specs' => 'list<map>', |
||
| 885 | 'name' => 'string', |
||
| 886 | 'notification_mode' => 'notification_mode_enum', |
||
| 887 | 'notification_uri' => 'string', |
||
| 888 | ); |
||
| 889 | $enums = array( |
||
| 890 | 'notification_mode_enum' => array( |
||
| 891 | 'OFF', |
||
| 892 | 'ON_COMPLETE', |
||
| 893 | ), |
||
| 894 | ); |
||
| 895 | |||
| 896 | $request = new ApiRequest( |
||
| 897 | $this->api, |
||
| 898 | $this->data['id'], |
||
| 899 | RequestInterface::METHOD_POST, |
||
| 900 | '/asyncadrequestsets', |
||
| 901 | new AdAsyncRequestSet(), |
||
| 902 | 'EDGE', |
||
| 903 | AdAsyncRequestSet::getFieldsEnum()->getValues(), |
||
| 904 | new TypeChecker($param_types, $enums) |
||
| 905 | ); |
||
| 906 | $request->addParams($params); |
||
| 907 | $request->addFields($fields); |
||
| 908 | return $pending ? $request : $request->execute(); |
||
| 909 | } |
||
| 910 | |||
| 911 | public function getBroadTargetingCategories(array $fields = array(), array $params = array(), $pending = false) { |
||
| 912 | $this->assureId(); |
||
| 913 | |||
| 914 | $param_types = array( |
||
| 915 | 'custom_categories_only' => 'bool', |
||
| 916 | ); |
||
| 917 | $enums = array( |
||
| 918 | ); |
||
| 919 | |||
| 920 | $request = new ApiRequest( |
||
| 921 | $this->api, |
||
| 922 | $this->data['id'], |
||
| 923 | RequestInterface::METHOD_GET, |
||
| 924 | '/broadtargetingcategories', |
||
| 925 | new BroadTargetingCategories(), |
||
| 926 | 'EDGE', |
||
| 927 | BroadTargetingCategories::getFieldsEnum()->getValues(), |
||
| 928 | new TypeChecker($param_types, $enums) |
||
| 929 | ); |
||
| 930 | $request->addParams($params); |
||
| 931 | $request->addFields($fields); |
||
| 932 | return $pending ? $request : $request->execute(); |
||
| 933 | } |
||
| 934 | |||
| 935 | public function deleteCampaigns(array $fields = array(), array $params = array(), $pending = false) { |
||
| 936 | $this->assureId(); |
||
| 937 | |||
| 938 | $param_types = array( |
||
| 939 | 'before_date' => 'datetime', |
||
| 940 | 'delete_strategy' => 'delete_strategy_enum', |
||
| 941 | 'object_count' => 'int', |
||
| 942 | ); |
||
| 943 | $enums = array( |
||
| 944 | 'delete_strategy_enum' => CampaignDeleteStrategyValues::getInstance()->getValues(), |
||
| 945 | ); |
||
| 946 | |||
| 947 | $request = new ApiRequest( |
||
| 948 | $this->api, |
||
| 949 | $this->data['id'], |
||
| 950 | RequestInterface::METHOD_DELETE, |
||
| 951 | '/campaigns', |
||
| 952 | new AbstractCrudObject(), |
||
| 953 | 'EDGE', |
||
| 954 | array(), |
||
| 955 | new TypeChecker($param_types, $enums) |
||
| 956 | ); |
||
| 957 | $request->addParams($params); |
||
| 958 | $request->addFields($fields); |
||
| 959 | return $pending ? $request : $request->execute(); |
||
| 960 | } |
||
| 961 | |||
| 962 | public function getCampaigns(array $fields = array(), array $params = array(), $pending = false) { |
||
| 963 | $this->assureId(); |
||
| 964 | |||
| 965 | $param_types = array( |
||
| 966 | 'date_preset' => 'date_preset_enum', |
||
| 967 | 'effective_status' => 'list<effective_status_enum>', |
||
| 968 | 'is_completed' => 'bool', |
||
| 969 | 'time_range' => 'Object', |
||
| 970 | ); |
||
| 971 | $enums = array( |
||
| 972 | 'date_preset_enum' => CampaignDatePresetValues::getInstance()->getValues(), |
||
| 973 | 'effective_status_enum' => CampaignEffectiveStatusValues::getInstance()->getValues(), |
||
| 974 | ); |
||
| 975 | |||
| 976 | $request = new ApiRequest( |
||
| 977 | $this->api, |
||
| 978 | $this->data['id'], |
||
| 979 | RequestInterface::METHOD_GET, |
||
| 980 | '/campaigns', |
||
| 981 | new Campaign(), |
||
| 982 | 'EDGE', |
||
| 983 | Campaign::getFieldsEnum()->getValues(), |
||
| 984 | new TypeChecker($param_types, $enums) |
||
| 985 | ); |
||
| 986 | $request->addParams($params); |
||
| 987 | $request->addFields($fields); |
||
| 988 | return $pending ? $request : $request->execute(); |
||
| 989 | } |
||
| 990 | |||
| 991 | public function createCampaign(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1025 | |||
| 1026 | public function getCampaignsByLabels(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1051 | |||
| 1052 | public function getCustomAudiences(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1079 | |||
| 1080 | public function createCustomAudience(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1123 | |||
| 1124 | public function getCustomAudiencesTos(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1146 | |||
| 1147 | public function createCustomConversion(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1148 | $this->assureId(); |
||
| 1149 | |||
| 1150 | $param_types = array( |
||
| 1151 | 'custom_event_type' => 'custom_event_type_enum', |
||
| 1152 | 'default_conversion_value' => 'float', |
||
| 1153 | 'description' => 'string', |
||
| 1154 | 'event_source_id' => 'string', |
||
| 1155 | 'name' => 'string', |
||
| 1156 | 'rule' => 'string', |
||
| 1157 | ); |
||
| 1158 | $enums = array( |
||
| 1159 | 'custom_event_type_enum' => CustomConversionCustomEventTypeValues::getInstance()->getValues(), |
||
| 1160 | ); |
||
| 1161 | |||
| 1162 | $request = new ApiRequest( |
||
| 1163 | $this->api, |
||
| 1164 | $this->data['id'], |
||
| 1165 | RequestInterface::METHOD_POST, |
||
| 1166 | '/customconversions', |
||
| 1167 | new CustomConversion(), |
||
| 1168 | 'EDGE', |
||
| 1169 | CustomConversion::getFieldsEnum()->getValues(), |
||
| 1170 | new TypeChecker($param_types, $enums) |
||
| 1171 | ); |
||
| 1172 | $request->addParams($params); |
||
| 1173 | $request->addFields($fields); |
||
| 1174 | return $pending ? $request : $request->execute(); |
||
| 1176 | |||
| 1177 | public function getDeliveryEstimate(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1203 | |||
| 1204 | public function getGeneratePreviews(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1237 | |||
| 1238 | public function getInsights(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1288 | |||
| 1289 | public function getInsightsAsync(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1339 | |||
| 1340 | public function getInstagramAccounts(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1362 | |||
| 1363 | public function getLeadGenForms(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1386 | |||
| 1387 | public function getMinimumBudgets(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1410 | |||
| 1411 | public function getOfflineConversionDataSets(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1433 | |||
| 1434 | public function getOffsitePixels(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1456 | |||
| 1457 | public function createOffsitePixel(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1482 | |||
| 1483 | public function getPartnerCategories(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1509 | |||
| 1510 | public function getPartners(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1532 | |||
| 1533 | public function createProductAudience(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1582 | |||
| 1583 | public function getPublisherBlockLists(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1605 | |||
| 1606 | public function createPublisherBlockList(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1629 | |||
| 1630 | public function getRateCard(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1652 | |||
| 1653 | public function getReachEstimate(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1681 | |||
| 1682 | public function getReachFrequencyPredictions(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1704 | |||
| 1705 | public function createReachFrequencyPrediction(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1744 | |||
| 1745 | public function getRoas(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1772 | |||
| 1773 | public function getTargetingBrowse(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1798 | |||
| 1799 | public function getTargetingSearch(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1824 | |||
| 1825 | public function getTargetingSentenceLines(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1850 | |||
| 1851 | public function getTargetingSuggestions(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1876 | |||
| 1877 | public function getTargetingValidation(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1902 | |||
| 1903 | public function deleteTracking(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1926 | |||
| 1927 | public function createTracking(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1950 | |||
| 1951 | public function getTransactions(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1975 | |||
| 1976 | public function getUsers(array $fields = array(), array $params = array(), $pending = false) { |
||
| 1998 | |||
| 1999 | public function getSelf(array $fields = array(), array $params = array(), $pending = false) { |
||
| 2021 | |||
| 2022 | public function updateSelf(array $fields = array(), array $params = array(), $pending = false) { |
||
| 2055 | |||
| 2056 | } |
||
| 2057 |