def CreateCustomAudience(name, description=None, f=None, datatype='email'):
audience = CustomAudience(parent_id=my_account.get_id_assured())
audience.update({CustomAudience.Field.name: name})
if description:
audience.update({CustomAudience.Field.description: description})
audience.remote_create()
print('Created custom audience id ' + audience[CustomAudience.Field.id])
if f and datatype:
LoadCustomAudience(audience, f, datatype)
def CreateCustomAudience(name, description=None, f=None, datatype='email'):
audience = CustomAudience(parent_id=my_account.get_id_assured())
audience.update({CustomAudience.Field.name: name})
if description:
audience.update({CustomAudience.Field.description: description})
audience.remote_create()
print('Created custom audience id ' + audience[CustomAudience.Field.id])
if f and datatype:
LoadCustomAudience(audience, f, datatype)
def CreateCustomAudience(ad_account, name, description=None, f=None, datatype='email'):
audience = CustomAudience(parent_id=ad_account.get_id_assured())
audience.update({
CustomAudience.Field.name: name,
CustomAudience.Field.subtype: CustomAudience.Subtype.custom,
})
if description:
audience.update({CustomAudience.Field.description: description})
audience.remote_create()
print('Created custom audience id ' + audience[CustomAudience.Field.id])
if f and datatype:
return LoadCustomAudience(audience, f, datatype)
return "No data was uploaded to audience. Only created custom audience id ' + audience[CustomAudience.Field.id]"
def create_audience(
self,
accountid,
app_id,
name,
retention_days,
event,
period,
greater_than=None,
less_than=None,
):
"""
Creates a new custom audience and returns the id. The custom audience
is created based on the cumulative values of the events (add to cart
or purchase) during the selected period, provided that app is logging
the selected app event and passing the right value with them.
"""
audience = CustomAudience(parent_id=accountid)
technique = {
'technique_name': 'absolute',
}
if greater_than is not None:
technique['lower_bound'] = greater_than
if less_than is not None:
technique['upper_bound'] = less_than
rule = {
'_application': app_id,
'_eventName': event,
'_cumulativeRule': {
'metric': 'amount',
'period': period,
'technique': technique,
},
}
audience.update({
CustomAudience.Field.name: name,
CustomAudience.Field.subtype: CustomAudience.Subtype.app,
CustomAudience.Field.retention_days: retention_days,
CustomAudience.Field.rule: json.dumps(rule),
})
audience.remote_create()
caid = audience[CustomAudience.Field.id]
return caid
##
# (#2654) Source Audience is Too Small: There aren't enough people in your
# source in the country you chose. Please choose a country that includes at
# least 100 people in your source.
custom_audience_id = fixtures.create_custom_audience().get_id_assured()
video_id = fixtures.upload_video(video_path)["id"]
# _DOC open [CUSTOM_AUDIENCE_CREATE_VIDEO_VIEWS_RETARGET]
# _DOC vars [ad_account_id:s, video_id]
from facebookads.objects import CustomAudience
lookalike = CustomAudience(parent_id=ad_account_id)
lookalike.update(
{
CustomAudience.Field.subtype: CustomAudience.Subtype.lookalike,
CustomAudience.Field.lookalike_spec: {
"ratio": 0.01,
"country": "US",
"engagement_specs": [{"action.type": "video_view", "post": video_id}],
"conversion_type": "dynamic_rule",
},
}
)
lookalike.remote_create()
print(lookalike)
# _DOC close [CUSTOM_AUDIENCE_CREATE_VIDEO_VIEWS_RETARGET]
lookalike.remote_delete()
from facebookads.objects import CustomAudience
audience = CustomAudience(custom_audience_id)
audience.remote_delete()
# _DOC close [CUSTOM_AUDIENCE_DELETE]
# _DOC open [CUSTOM_AUDIENCE_CREATE_VIDEO_VIEWS_RETARGET]
# _DOC vars [ad_account_id:s, video_id]
from facebookads.objects import CustomAudience
lookalike = CustomAudience(parent_id=ad_account_id)
lookalike.update({
CustomAudience.Field.lookalike_spec: {
'ratio': 0.01,
'country': 'US',
'engagement_specs': [
{
'action.type': 'video_view',
'post': video_id,
},
],
'conversion_type': 'dynamic_rule',
},
})
lookalike.remote_create()
print(lookalike)
# _DOC close [CUSTOM_AUDIENCE_CREATE_VIDEO_VIEWS_RETARGET]
lookalike.remote_delete()
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from facebookads import test_config
ad_account_id = test_config.account_id
page_id = test_config.page_id
# _DOC open [LOOKALIKE_CREATE_PAGE_FAN]
# _DOC vars [ad_account_id:s, pixel_id:s, page_id:s]
from facebookads.objects import CustomAudience
lookalike = CustomAudience(parent_id=ad_account_id)
lookalike.update({
CustomAudience.Field.name: 'My lookalike audience',
CustomAudience.Field.subtype: CustomAudience.Subtype.lookalike,
CustomAudience.Field.lookalike_spec: {
'ratio': 0.01,
'country': 'US',
'page_id': page_id,
'conversion_type': 'page_like',
},
})
lookalike.remote_create()
print(lookalike)
# _DOC close [LOOKALIKE_CREATE_PAGE_FAN]
lookalike.remote_delete()
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from examples.docs import fixtures
from facebookads import test_config
ad_account_id = test_config.account_id
pixel_id = fixtures.create_ads_pixel().get_id()
# _DOC open [LOOKALIKE_CREATE_CONVERSION_DATA]
# _DOC vars [ad_account_id:s, pixel_id:s]
from facebookads.objects import CustomAudience
lookalike = CustomAudience(parent_id=ad_account_id)
lookalike.update({
CustomAudience.Field.name: 'My lookalike audience',
CustomAudience.Field.subtype: CustomAudience.Subtype.lookalike,
CustomAudience.Field.lookalike_spec: {
'pixel_ids': [pixel_id],
'ratio': 0.01,
'conversion_type': 'offsite',
'country': 'US',
},
})
lookalike.remote_create()
print(lookalike)
# _DOC close [LOOKALIKE_CREATE_CONVERSION_DATA]
lookalike.remote_delete()
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from examples.docs import fixtures
from facebookads import test_config
ad_account_id = test_config.account_id
campaign_id = fixtures.create_campaign().get_id()
# _DOC open [LOOKALIKE_CREATE_CAMPAIGN_CONVERSION]
# _DOC vars [ad_account_id:s, campaign_id:s, seed_audience_id:s]
from facebookads.objects import CustomAudience
lookalike = CustomAudience(parent_id=ad_account_id)
lookalike.update({
CustomAudience.Field.subtype: CustomAudience.Subtype.lookalike,
CustomAudience.Field.lookalike_spec: {
'origin_ids': campaign_id,
'starting_ratio': 0.03,
'ratio': 0.05,
'conversion_type': 'campaign_conversions',
'country': 'US',
},
})
lookalike.remote_create()
print(lookalike)
# _DOC close [LOOKALIKE_CREATE_CAMPAIGN_CONVERSION]
lookalike.remote_delete()
from facebookads.objects import CustomAudience
audience = CustomAudience(custom_audience_id)
audience.remote_delete()
# _DOC close [CUSTOM_AUDIENCE_DELETE]
# _DOC open [CUSTOM_AUDIENCE_CREATE_VIDEO_VIEWS_RETARGET]
# _DOC vars [ad_account_id:s, video_id]
from facebookads.objects import CustomAudience
lookalike = CustomAudience(parent_id=ad_account_id)
lookalike.update({
CustomAudience.Field.lookalike_spec: {
'ratio': 0.01,
'country': 'US',
'engagement_specs': [
{
'action.type': 'video_view',
'post': video_id,
},
],
'conversion_type': 'dynamic_rule',
},
})
lookalike.remote_create()
print(lookalike)
# _DOC close [CUSTOM_AUDIENCE_CREATE_VIDEO_VIEWS_RETARGET]
lookalike.remote_delete()
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from examples.docs import fixtures
from facebookads import test_config
ad_account_id = test_config.account_id
seed_audience_id = fixtures.create_custom_audience().get_id()
# _DOC open [LOOKALIKE_CREATE]
# _DOC vars [ad_account_id:s, campaign_id:s, seed_audience_id:s]
from facebookads.objects import CustomAudience
lookalike = CustomAudience(parent_id=ad_account_id)
lookalike.update({
CustomAudience.Field.name: 'My lookalike audience',
CustomAudience.Field.subtype: CustomAudience.Subtype.lookalike,
CustomAudience.Field.origin_audience_id: seed_audience_id,
CustomAudience.Field.lookalike_spec: {
'type': 'similarity',
'country': 'US',
},
})
lookalike.remote_create()
print(lookalike)
# _DOC close [LOOKALIKE_CREATE]
lookalike.remote_delete()
