How to use the facebookads.typechecker.TypeChecker function in facebookads
To help you get started, we’ve selected a few facebookads examples, based on popular ways it is used in public projects.
Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.
facebook / facebook-python-business-sdk / facebookads / adobjects / business.py View on Github 
from facebookads.adobjects.profilepicturesource import ProfilePictureSource
param_types = {
'height': 'int',
'redirect': 'bool',
'type': 'type_enum',
'width': 'int',
}
enums = {
'type_enum': ProfilePictureSource.Type.__dict__.values(),
}
request = FacebookRequest(
node_id=self['id'],
method='GET',
endpoint='/picture',
api=self._api,
param_checker=TypeChecker(param_types, enums),
target_class=ProfilePictureSource,
api_type='EDGE',
response_parser=ObjectParser(target_class=ProfilePictureSource, api=self._api),
)
request.add_params(params)
request.add_fields(fields)
if batch is not None:
request.add_to_batch(batch)
return request
elif pending:
return request
else:
self.assure_call()
return request.execute()def create_owned_ad_account(self, fields=None, params=None, batch=None, pending=False):
from facebookads.adobjects.adaccount import AdAccount
param_types = {
'adaccount_id': 'string',
}
enums = {
}
request = FacebookRequest(
node_id=self['id'],
method='POST',
endpoint='/owned_ad_accounts',
api=self._api,
param_checker=TypeChecker(param_types, enums),
target_class=AdAccount,
api_type='EDGE',
response_parser=ObjectParser(target_class=AdAccount, api=self._api),
)
request.add_params(params)
request.add_fields(fields)
if batch is not None:
request.add_to_batch(batch)
return request
elif pending:
return request
else:
self.assure_call()
return request.execute()def create_ads_pixel(self, fields=None, params=None, batch=None, pending=False):
from facebookads.adobjects.adspixel import AdsPixel
param_types = {
'name': 'string',
}
enums = {
}
request = FacebookRequest(
node_id=self['id'],
method='POST',
endpoint='/adspixels',
api=self._api,
param_checker=TypeChecker(param_types, enums),
target_class=AdsPixel,
api_type='EDGE',
response_parser=ObjectParser(target_class=AdsPixel, api=self._api),
)
request.add_params(params)
request.add_fields(fields)
if batch is not None:
request.add_to_batch(batch)
return request
elif pending:
return request
else:
self.assure_call()
return request.execute()def get_shared_audience_permissions(self, fields=None, params=None, batch=None, pending=False):
param_types = {
'partner_id': 'string',
}
enums = {
}
request = FacebookRequest(
node_id=self['id'],
method='GET',
endpoint='/shared_audience_permissions',
api=self._api,
param_checker=TypeChecker(param_types, enums),
target_class=AbstractCrudObject,
api_type='EDGE',
response_parser=ObjectParser(target_class=AbstractCrudObject, api=self._api),
)
request.add_params(params)
request.add_fields(fields)
if batch is not None:
request.add_to_batch(batch)
return request
elif pending:
return request
else:
self.assure_call()
return request.execute()def get_owned_instagram_accounts(self, fields=None, params=None, batch=None, pending=False):
param_types = {
}
enums = {
}
request = FacebookRequest(
node_id=self['id'],
method='GET',
endpoint='/owned_instagram_accounts',
api=self._api,
param_checker=TypeChecker(param_types, enums),
target_class=AbstractCrudObject,
api_type='EDGE',
response_parser=ObjectParser(target_class=AbstractCrudObject, api=self._api),
)
request.add_params(params)
request.add_fields(fields)
if batch is not None:
request.add_to_batch(batch)
return request
elif pending:
return request
else:
self.assure_call()
return request.execute()def create_owned_page(self, fields=None, params=None, batch=None, pending=False):
param_types = {
'page_id': 'int',
}
enums = {
}
request = FacebookRequest(
node_id=self['id'],
method='POST',
endpoint='/owned_pages',
api=self._api,
param_checker=TypeChecker(param_types, enums),
target_class=AbstractCrudObject,
api_type='EDGE',
response_parser=ObjectParser(target_class=AbstractCrudObject, api=self._api),
)
request.add_params(params)
request.add_fields(fields)
if batch is not None:
request.add_to_batch(batch)
return request
elif pending:
return request
else:
self.assure_call()
return request.execute()def get_instagram_accounts(self, fields=None, params=None, batch=None, pending=False):
param_types = {
}
enums = {
}
request = FacebookRequest(
node_id=self['id'],
method='GET',
endpoint='/instagram_accounts',
api=self._api,
param_checker=TypeChecker(param_types, enums),
target_class=AbstractCrudObject,
api_type='EDGE',
response_parser=ObjectParser(target_class=AbstractCrudObject, api=self._api),
)
request.add_params(params)
request.add_fields(fields)
if batch is not None:
request.add_to_batch(batch)
return request
elif pending:
return request
else:
self.assure_call()
return request.execute()def get_grp_plans(self, fields=None, params=None, batch=None, pending=False):
from facebookads.adobjects.reachfrequencyprediction import ReachFrequencyPrediction
param_types = {
'status': 'status_enum',
}
enums = {
'status_enum': ReachFrequencyPrediction.Status.__dict__.values(),
}
request = FacebookRequest(
node_id=self['id'],
method='GET',
endpoint='/grp_plans',
api=self._api,
param_checker=TypeChecker(param_types, enums),
target_class=ReachFrequencyPrediction,
api_type='EDGE',
response_parser=ObjectParser(target_class=ReachFrequencyPrediction, api=self._api),
)
request.add_params(params)
request.add_fields(fields)
if batch is not None:
request.add_to_batch(batch)
return request
elif pending:
return request
else:
self.assure_call()
return request.execute()}
enums = {
'report_type_enum': [
'multi_channel_report',
'video_metrics_report',
'fruit_rollup_report',
'third_party_mta_report',
'partner_lift_study_report',
],
}
request = FacebookRequest(
node_id=self['id'],
method='GET',
endpoint='/measurement_reports',
api=self._api,
param_checker=TypeChecker(param_types, enums),
target_class=AbstractCrudObject,
api_type='EDGE',
response_parser=ObjectParser(target_class=AbstractCrudObject, api=self._api),
)
request.add_params(params)
request.add_fields(fields)
if batch is not None:
request.add_to_batch(batch)
return request
elif pending:
return request
else:
self.assure_call()
return request.execute()def get_client_pages(self, fields=None, params=None, batch=None, pending=False):
from facebookads.adobjects.page import Page
param_types = {
}
enums = {
}
request = FacebookRequest(
node_id=self['id'],
method='GET',
endpoint='/client_pages',
api=self._api,
param_checker=TypeChecker(param_types, enums),
target_class=Page,
api_type='EDGE',
response_parser=ObjectParser(target_class=Page, api=self._api),
)
request.add_params(params)
request.add_fields(fields)
if batch is not None:
request.add_to_batch(batch)
return request
elif pending:
return request
else:
self.assure_call()
return request.execute()
Popular facebookads functions
- facebookads.adobjects.objectparser.ObjectParser
- facebookads.api.FacebookRequest
- facebookads.FacebookAdsApi
- facebookads.FacebookAdsApi.get_default_api
- facebookads.objects.AdAccount
- facebookads.objects.AdCampaign
- facebookads.objects.AdCampaign.Field
- facebookads.objects.AdCreative
- facebookads.objects.AdCreative.Field
- facebookads.objects.AdGroup
- facebookads.objects.AdGroup.Field
- facebookads.objects.AdImage
- facebookads.objects.AdSet
- facebookads.objects.AdSet.Field
- facebookads.objects.AdsPixel
- facebookads.objects.Campaign
- facebookads.objects.CustomAudience
- facebookads.test_config
- facebookads.test_config.account_id
- facebookads.typechecker.TypeChecker