# 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. from facebook_business.adobjects.abstractobject import AbstractObject from facebook_business.adobjects.abstractcrudobject import AbstractCrudObject from facebook_business.adobjects.objectparser import ObjectParser from facebook_business.api import FacebookRequest from facebook_business.typechecker import TypeChecker from facebook_business.mixins import HasAdLabels """ 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 Ad( AbstractCrudObject, HasAdLabels, ): def __init__(self, fbid=None, parent_id=None, api=None): self._isAd = True super(Ad, self).__init__(fbid, parent_id, api) class Field(AbstractObject.Field): account_id = 'account_id' ad_active_time = 'ad_active_time' ad_review_feedback = 'ad_review_feedback' ad_schedule_end_time = 'ad_schedule_end_time' ad_schedule_start_time = 'ad_schedule_start_time' adlabels = 'adlabels' adset = 'adset' adset_id = 'adset_id' bid_amount = 'bid_amount' bid_info = 'bid_info' bid_type = 'bid_type' campaign = 'campaign' campaign_id = 'campaign_id' configured_status = 'configured_status' conversion_domain = 'conversion_domain' conversion_specs = 'conversion_specs' created_time = 'created_time' creative = 'creative' creative_asset_groups_spec = 'creative_asset_groups_spec' creative_audience_pairing_persona = 'creative_audience_pairing_persona' creative_automation_spec = 'creative_automation_spec' demolink_hash = 'demolink_hash' display_sequence = 'display_sequence' effective_status = 'effective_status' engagement_audience = 'engagement_audience' failed_delivery_checks = 'failed_delivery_checks' id = 'id' issues_info = 'issues_info' last_updated_by_app_id = 'last_updated_by_app_id' name = 'name' placement = 'placement' preview_shareable_link = 'preview_shareable_link' priority = 'priority' recommendations = 'recommendations' source_ad = 'source_ad' source_ad_id = 'source_ad_id' special_ad_categories = 'special_ad_categories' status = 'status' targeting = 'targeting' tracking_and_conversion_with_defaults = 'tracking_and_conversion_with_defaults' tracking_specs = 'tracking_specs' updated_time = 'updated_time' adset_spec = 'adset_spec' audience_id = 'audience_id' dataset_split_specs = 'dataset_split_specs' date_format = 'date_format' draft_adgroup_id = 'draft_adgroup_id' execution_options = 'execution_options' include_demolink_hashes = 'include_demolink_hashes' filename = 'filename' class BidType: absolute_ocpm = 'ABSOLUTE_OCPM' cpa = 'CPA' cpc = 'CPC' cpm = 'CPM' multi_premium = 'MULTI_PREMIUM' class ConfiguredStatus: active = 'ACTIVE' archived = 'ARCHIVED' deleted = 'DELETED' paused = 'PAUSED' class EffectiveStatus: active = 'ACTIVE' adset_paused = 'ADSET_PAUSED' archived = 'ARCHIVED' campaign_paused = 'CAMPAIGN_PAUSED' deleted = 'DELETED' disapproved = 'DISAPPROVED' in_process = 'IN_PROCESS' paused = 'PAUSED' pending_billing_info = 'PENDING_BILLING_INFO' pending_review = 'PENDING_REVIEW' preapproved = 'PREAPPROVED' with_issues = 'WITH_ISSUES' class Status: active = 'ACTIVE' archived = 'ARCHIVED' deleted = 'DELETED' paused = 'PAUSED' class DatePreset: data_maximum = 'data_maximum' last_14d = 'last_14d' last_28d = 'last_28d' last_30d = 'last_30d' last_3d = 'last_3d' last_7d = 'last_7d' last_90d = 'last_90d' last_month = 'last_month' last_quarter = 'last_quarter' last_week_mon_sun = 'last_week_mon_sun' last_week_sun_sat = 'last_week_sun_sat' last_year = 'last_year' maximum = 'maximum' this_month = 'this_month' this_quarter = 'this_quarter' this_week_mon_today = 'this_week_mon_today' this_week_sun_today = 'this_week_sun_today' this_year = 'this_year' today = 'today' yesterday = 'yesterday' class ExecutionOptions: include_recommendations = 'include_recommendations' synchronous_ad_review = 'synchronous_ad_review' validate_only = 'validate_only' class Operator: all = 'ALL' any = 'ANY' class StatusOption: active = 'ACTIVE' inherited_from_source = 'INHERITED_FROM_SOURCE' paused = 'PAUSED' # @deprecated get_endpoint function is deprecated @classmethod def get_endpoint(cls): return 'ads' # @deprecated api_create is being deprecated def api_create(self, parent_id, fields=None, params=None, batch=None, success=None, failure=None, pending=False): from facebook_business.adobjects.adaccount import AdAccount return AdAccount(api=self._api, fbid=parent_id).create_ad(fields, params, batch, success, failure, pending) def api_delete(self, fields=None, params=None, batch=None, success=None, failure=None, pending=False): from facebook_business.utils import api_utils if batch is None and (success is not None or failure is not None): api_utils.warning('`success` and `failure` callback only work for batch call.') param_types = { } enums = { } request = FacebookRequest( node_id=self['id'], method='DELETE', endpoint='/', api=self._api, param_checker=TypeChecker(param_types, enums), target_class=AbstractCrudObject, api_type='NODE', response_parser=ObjectParser(reuse_object=self), ) request.add_params(params) request.add_fields(fields) if batch is not None: request.add_to_batch(batch, success=success, failure=failure) return request elif pending: return request else: self.assure_call() return request.execute() def api_get(self, fields=None, params=None, batch=None, success=None, failure=None, pending=False): from facebook_business.utils import api_utils if batch is None and (success is not None or failure is not None): api_utils.warning('`success` and `failure` callback only work for batch call.') param_types = { 'am_call_tags': 'map', 'date_preset': 'date_preset_enum', 'from_adtable': 'bool', 'review_feedback_breakdown': 'bool', 'time_range': 'map', } enums = { 'date_preset_enum': [ '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 = FacebookRequest( node_id=self['id'], method='GET', endpoint='/', api=self._api, param_checker=TypeChecker(param_types, enums), target_class=Ad, api_type='NODE', response_parser=ObjectParser(reuse_object=self), ) request.add_params(params) request.add_fields(fields) if batch is not None: request.add_to_batch(batch, success=success, failure=failure) return request elif pending: return request else: self.assure_call() return request.execute() def api_update(self, fields=None, params=None, batch=None, success=None, failure=None, pending=False): from facebook_business.utils import api_utils if batch is None and (success is not None or failure is not None): api_utils.warning('`success` and `failure` callback only work for batch call.') param_types = { 'ad_schedule_end_time': 'datetime', 'ad_schedule_start_time': 'datetime', 'adlabels': 'list', 'adset_spec': 'AdSet', 'audience_id': 'string', 'bid_amount': 'int', 'conversion_domain': 'string', 'creative': 'AdCreative', 'creative_asset_groups_spec': 'Object', 'creative_audience_pairing_persona': 'map', 'creative_automation_spec': 'Object', 'display_sequence': 'unsigned int', 'draft_adgroup_id': 'string', 'engagement_audience': 'bool', 'execution_options': 'list', 'include_demolink_hashes': 'bool', 'name': 'string', 'priority': 'unsigned int', 'status': 'status_enum', 'tracking_specs': 'Object', } enums = { 'execution_options_enum': Ad.ExecutionOptions.__dict__.values(), 'status_enum': Ad.Status.__dict__.values(), } request = FacebookRequest( node_id=self['id'], method='POST', endpoint='/', api=self._api, param_checker=TypeChecker(param_types, enums), target_class=Ad, api_type='NODE', response_parser=ObjectParser(reuse_object=self), ) request.add_params(params) request.add_fields(fields) if batch is not None: request.add_to_batch(batch, success=success, failure=failure) return request elif pending: return request else: self.assure_call() return request.execute() def get_ad_creatives(self, fields=None, params=None, batch=None, success=None, failure=None, pending=False): from facebook_business.utils import api_utils if batch is None and (success is not None or failure is not None): api_utils.warning('`success` and `failure` callback only work for batch call.') from facebook_business.adobjects.adcreative import AdCreative param_types = { } enums = { } request = FacebookRequest( node_id=self['id'], method='GET', endpoint='/adcreatives', api=self._api, param_checker=TypeChecker(param_types, enums), target_class=AdCreative, api_type='EDGE', response_parser=ObjectParser(target_class=AdCreative, api=self._api), ) request.add_params(params) request.add_fields(fields) if batch is not None: request.add_to_batch(batch, success=success, failure=failure) return request elif pending: return request else: self.assure_call() return request.execute() def create_ad_label(self, fields=None, params=None, batch=None, success=None, failure=None, pending=False): from facebook_business.utils import api_utils if batch is None and (success is not None or failure is not None): api_utils.warning('`success` and `failure` callback only work for batch call.') param_types = { 'adlabels': 'list', 'execution_options': 'list', } enums = { 'execution_options_enum': Ad.ExecutionOptions.__dict__.values(), } request = FacebookRequest( node_id=self['id'], method='POST', endpoint='/adlabels', api=self._api, param_checker=TypeChecker(param_types, enums), target_class=Ad, api_type='EDGE', response_parser=ObjectParser(target_class=Ad, api=self._api), ) request.add_params(params) request.add_fields(fields) if batch is not None: request.add_to_batch(batch, success=success, failure=failure) return request elif pending: return request else: self.assure_call() return request.execute() def get_ad_rules_governed(self, fields=None, params=None, batch=None, success=None, failure=None, pending=False): from facebook_business.utils import api_utils if batch is None and (success is not None or failure is not None): api_utils.warning('`success` and `failure` callback only work for batch call.') from facebook_business.adobjects.adrule import AdRule param_types = { 'pass_evaluation': 'bool', } enums = { } request = FacebookRequest( node_id=self['id'], method='GET', endpoint='/adrules_governed', api=self._api, param_checker=TypeChecker(param_types, enums), target_class=AdRule, api_type='EDGE', response_parser=ObjectParser(target_class=AdRule, api=self._api), ) request.add_params(params) request.add_fields(fields) if batch is not None: request.add_to_batch(batch, success=success, failure=failure) return request elif pending: return request else: self.assure_call() return request.execute() def get_copies(self, fields=None, params=None, batch=None, success=None, failure=None, pending=False): from facebook_business.utils import api_utils if batch is None and (success is not None or failure is not None): api_utils.warning('`success` and `failure` callback only work for batch call.') param_types = { 'date_preset': 'date_preset_enum', 'effective_status': 'list', 'time_range': 'map', 'updated_since': 'int', } enums = { 'date_preset_enum': Ad.DatePreset.__dict__.values(), } request = FacebookRequest( node_id=self['id'], method='GET', endpoint='/copies', api=self._api, param_checker=TypeChecker(param_types, enums), target_class=Ad, api_type='EDGE', response_parser=ObjectParser(target_class=Ad, api=self._api), ) request.add_params(params) request.add_fields(fields) if batch is not None: request.add_to_batch(batch, success=success, failure=failure) return request elif pending: return request else: self.assure_call() return request.execute() def create_copy(self, fields=None, params=None, batch=None, success=None, failure=None, pending=False): from facebook_business.utils import api_utils if batch is None and (success is not None or failure is not None): api_utils.warning('`success` and `failure` callback only work for batch call.') param_types = { 'adset_id': 'string', 'creative_parameters': 'AdCreative', 'rename_options': 'Object', 'status_option': 'status_option_enum', } enums = { 'status_option_enum': Ad.StatusOption.__dict__.values(), } request = FacebookRequest( node_id=self['id'], method='POST', endpoint='/copies', api=self._api, param_checker=TypeChecker(param_types, enums), target_class=Ad, api_type='EDGE', response_parser=ObjectParser(target_class=Ad, api=self._api), ) request.add_params(params) request.add_fields(fields) if batch is not None: request.add_to_batch(batch, success=success, failure=failure) return request elif pending: return request else: self.assure_call() return request.execute() def get_insights(self, fields=None, params=None, is_async=False, batch=None, success=None, failure=None, pending=False): from facebook_business.utils import api_utils if batch is None and (success is not None or failure is not None): api_utils.warning('`success` and `failure` callback only work for batch call.') from facebook_business.adobjects.adsinsights import AdsInsights if is_async: return self.get_insights_async(fields, params, batch, success, failure, pending) param_types = { 'action_attribution_windows': 'list', 'action_breakdowns': 'list', 'action_report_time': 'action_report_time_enum', 'breakdowns': 'list', 'date_preset': 'date_preset_enum', 'default_summary': 'bool', 'export_columns': 'list', 'export_format': 'string', 'export_name': 'string', 'fields': 'list', 'filtering': 'list', 'graph_cache': 'bool', 'level': 'level_enum', 'limit': 'int', 'product_id_limit': 'int', 'sort': 'list', 'summary': 'list', 'summary_action_breakdowns': 'list', 'time_increment': 'string', 'time_range': 'map', 'time_ranges': 'list', 'use_account_attribution_setting': 'bool', 'use_unified_attribution_setting': 'bool', } enums = { 'action_attribution_windows_enum': AdsInsights.ActionAttributionWindows.__dict__.values(), 'action_breakdowns_enum': AdsInsights.ActionBreakdowns.__dict__.values(), 'action_report_time_enum': AdsInsights.ActionReportTime.__dict__.values(), 'breakdowns_enum': AdsInsights.Breakdowns.__dict__.values(), 'date_preset_enum': AdsInsights.DatePreset.__dict__.values(), 'level_enum': AdsInsights.Level.__dict__.values(), 'summary_action_breakdowns_enum': AdsInsights.SummaryActionBreakdowns.__dict__.values(), } request = FacebookRequest( node_id=self['id'], method='GET', endpoint='/insights', api=self._api, param_checker=TypeChecker(param_types, enums), target_class=AdsInsights, api_type='EDGE', response_parser=ObjectParser(target_class=AdsInsights, api=self._api), include_summary=False, ) request.add_params(params) request.add_fields(fields) if batch is not None: request.add_to_batch(batch, success=success, failure=failure) return request elif pending: return request else: self.assure_call() return request.execute() def get_insights_async(self, fields=None, params=None, batch=None, success=None, failure=None, pending=False): from facebook_business.utils import api_utils if batch is None and (success is not None or failure is not None): api_utils.warning('`success` and `failure` callback only work for batch call.') from facebook_business.adobjects.adreportrun import AdReportRun from facebook_business.adobjects.adsinsights import AdsInsights param_types = { 'action_attribution_windows': 'list', 'action_breakdowns': 'list', 'action_report_time': 'action_report_time_enum', 'breakdowns': 'list', 'date_preset': 'date_preset_enum', 'default_summary': 'bool', 'export_columns': 'list', 'export_format': 'string', 'export_name': 'string', 'fields': 'list', 'filtering': 'list', 'graph_cache': 'bool', 'level': 'level_enum', 'limit': 'int', 'product_id_limit': 'int', 'sort': 'list', 'summary': 'list', 'summary_action_breakdowns': 'list', 'time_increment': 'string', 'time_range': 'map', 'time_ranges': 'list', 'use_account_attribution_setting': 'bool', 'use_unified_attribution_setting': 'bool', } enums = { 'action_attribution_windows_enum': AdsInsights.ActionAttributionWindows.__dict__.values(), 'action_breakdowns_enum': AdsInsights.ActionBreakdowns.__dict__.values(), 'action_report_time_enum': AdsInsights.ActionReportTime.__dict__.values(), 'breakdowns_enum': AdsInsights.Breakdowns.__dict__.values(), 'date_preset_enum': AdsInsights.DatePreset.__dict__.values(), 'level_enum': AdsInsights.Level.__dict__.values(), 'summary_action_breakdowns_enum': AdsInsights.SummaryActionBreakdowns.__dict__.values(), } if fields is not None: params['fields'] = params.get('fields') if params.get('fields') is not None else list() params['fields'].extend(field for field in fields if field not in params['fields']) request = FacebookRequest( node_id=self['id'], method='POST', endpoint='/insights', api=self._api, param_checker=TypeChecker(param_types, enums), target_class=AdReportRun, api_type='EDGE', response_parser=ObjectParser(target_class=AdReportRun, api=self._api), include_summary=False, ) request.add_params(params) if batch is not None: request.add_to_batch(batch, success=success, failure=failure) return request elif pending: return request else: self.assure_call() return request.execute() def get_leads(self, fields=None, params=None, batch=None, success=None, failure=None, pending=False): from facebook_business.utils import api_utils if batch is None and (success is not None or failure is not None): api_utils.warning('`success` and `failure` callback only work for batch call.') from facebook_business.adobjects.lead import Lead param_types = { } enums = { } request = FacebookRequest( node_id=self['id'], method='GET', endpoint='/leads', api=self._api, param_checker=TypeChecker(param_types, enums), target_class=Lead, api_type='EDGE', response_parser=ObjectParser(target_class=Lead, api=self._api), ) request.add_params(params) request.add_fields(fields) if batch is not None: request.add_to_batch(batch, success=success, failure=failure) return request elif pending: return request else: self.assure_call() return request.execute() def get_previews(self, fields=None, params=None, batch=None, success=None, failure=None, pending=False): from facebook_business.utils import api_utils if batch is None and (success is not None or failure is not None): api_utils.warning('`success` and `failure` callback only work for batch call.') from facebook_business.adobjects.adpreview import AdPreview param_types = { 'ad_format': 'ad_format_enum', 'creative_feature': 'creative_feature_enum', 'dynamic_asset_label': 'string', 'dynamic_creative_spec': 'Object', 'dynamic_customization': 'Object', 'end_date': 'datetime', 'height': 'unsigned int', 'locale': 'string', 'place_page_id': 'int', 'post': 'Object', 'product_item_ids': 'list', 'render_type': 'render_type_enum', 'start_date': 'datetime', 'width': 'unsigned int', } enums = { 'ad_format_enum': AdPreview.AdFormat.__dict__.values(), 'creative_feature_enum': AdPreview.CreativeFeature.__dict__.values(), 'render_type_enum': AdPreview.RenderType.__dict__.values(), } request = FacebookRequest( node_id=self['id'], method='GET', endpoint='/previews', api=self._api, param_checker=TypeChecker(param_types, enums), target_class=AdPreview, api_type='EDGE', response_parser=ObjectParser(target_class=AdPreview, api=self._api), ) request.add_params(params) request.add_fields(fields) if batch is not None: request.add_to_batch(batch, success=success, failure=failure) return request elif pending: return request else: self.assure_call() return request.execute() def get_targeting_sentence_lines(self, fields=None, params=None, batch=None, success=None, failure=None, pending=False): from facebook_business.utils import api_utils if batch is None and (success is not None or failure is not None): api_utils.warning('`success` and `failure` callback only work for batch call.') from facebook_business.adobjects.targetingsentenceline import TargetingSentenceLine param_types = { } enums = { } request = FacebookRequest( node_id=self['id'], method='GET', endpoint='/targetingsentencelines', api=self._api, param_checker=TypeChecker(param_types, enums), target_class=TargetingSentenceLine, api_type='EDGE', response_parser=ObjectParser(target_class=TargetingSentenceLine, api=self._api), ) request.add_params(params) request.add_fields(fields) if batch is not None: request.add_to_batch(batch, success=success, failure=failure) return request elif pending: return request else: self.assure_call() return request.execute() _field_types = { 'account_id': 'string', 'ad_active_time': 'string', 'ad_review_feedback': 'AdgroupReviewFeedback', 'ad_schedule_end_time': 'datetime', 'ad_schedule_start_time': 'datetime', 'adlabels': 'list', 'adset': 'AdSet', 'adset_id': 'string', 'bid_amount': 'int', 'bid_info': 'map', 'bid_type': 'BidType', 'campaign': 'Campaign', 'campaign_id': 'string', 'configured_status': 'ConfiguredStatus', 'conversion_domain': 'string', 'conversion_specs': 'list', 'created_time': 'datetime', 'creative': 'AdCreative', 'creative_asset_groups_spec': 'AdCreativeAssetGroupsSpec', 'creative_audience_pairing_persona': 'CreativeAudiencePairingPersona', 'creative_automation_spec': 'AdCreativeAutomationSpec', 'demolink_hash': 'string', 'display_sequence': 'int', 'effective_status': 'EffectiveStatus', 'engagement_audience': 'bool', 'failed_delivery_checks': 'list', 'id': 'string', 'issues_info': 'list', 'last_updated_by_app_id': 'string', 'name': 'string', 'placement': 'Placement', 'preview_shareable_link': 'string', 'priority': 'unsigned int', 'recommendations': 'list', 'source_ad': 'Ad', 'source_ad_id': 'string', 'special_ad_categories': 'list', 'status': 'Status', 'targeting': 'Targeting', 'tracking_and_conversion_with_defaults': 'TrackingAndConversionWithDefaults', 'tracking_specs': 'list', 'updated_time': 'datetime', 'adset_spec': 'AdSet', 'audience_id': 'string', 'dataset_split_specs': 'list', 'date_format': 'string', 'draft_adgroup_id': 'string', 'execution_options': 'list', 'include_demolink_hashes': 'bool', 'filename': 'file' } @classmethod def _get_field_enum_info(cls): field_enum_info = {} field_enum_info['BidType'] = Ad.BidType.__dict__.values() field_enum_info['ConfiguredStatus'] = Ad.ConfiguredStatus.__dict__.values() field_enum_info['EffectiveStatus'] = Ad.EffectiveStatus.__dict__.values() field_enum_info['Status'] = Ad.Status.__dict__.values() field_enum_info['DatePreset'] = Ad.DatePreset.__dict__.values() field_enum_info['ExecutionOptions'] = Ad.ExecutionOptions.__dict__.values() field_enum_info['Operator'] = Ad.Operator.__dict__.values() field_enum_info['StatusOption'] = Ad.StatusOption.__dict__.values() return field_enum_info