xMsg javascript has not been loaded.
Name: AdVideosByAdAccount
Catalog: V32
Schema: Marketing
Parameters: ad_account_id
Name |
Data Type |
Required |
Default Value |
Documentation |
---|---|---|---|---|
ad_account_id |
string |
☑ |
|
Facebook ads account ID including prefix 'act_'. |
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
ad_breaks |
string |
itgen_facebook_ad_breaks |
☐ |
List of time offsets of ad breaks in milliseconds. Ad breaks are short ads that play within a video. |
backdated_time |
datetime |
itgen_facebook_backdated_time |
☐ |
The time when the video post was created. |
backdated_time_granularity |
string |
itgen_facebook_backdated_time_granularity |
☐ |
Accuracy of the backdated time. |
content_category |
string |
itgen_facebook_content_category |
☐ |
The content category of this video. |
content_tags |
string |
itgen_facebook_content_tags |
☐ |
List of tags that describe the contents of the video. |
created_time |
datetime |
Created |
☐ |
The time the video was initially published. |
custom_labels |
string |
itgen_facebook_custom_labels |
☐ |
List of labels used to describe the video. Unlike content tags, custom labels are not published and only appear in insights data. |
description |
string |
Description |
☐ |
The description of the video. |
embed_html |
string |
itgen_facebook_embed_html |
☐ |
The HTML element that may be embedded in a Web page to play the video. |
embeddable |
boolean |
itgen_facebook_embeddable |
☐ |
Whether the video is embeddable. |
event_attending_count |
int32 |
itgen_facebook_event_attending_count |
☐ |
Number of people attending the event. |
event_can_guests_invite |
boolean |
itgen_facebook_event_can_guests_invite |
☐ |
Can guests invite friends. Requires an access token of an Admin of the Event. |
event_category |
string |
itgen_facebook_event_category |
☐ |
The category of the event. |
event_declined_count |
int32 |
itgen_facebook_event_declined_count |
☐ |
Number of people who declined the event. |
event_description |
string |
itgen_facebook_event_description |
☐ |
Long-form description. |
event_discount_code_enabled |
boolean |
itgen_facebook_event_discount_code_enabled |
☐ |
Is discount code enabled for this event. |
event_end_time |
string |
itgen_facebook_event_end_time |
☐ |
End time, if one has been set. |
event_guest_list_enabled |
boolean |
itgen_facebook_event_guest_list_enabled |
☐ |
Can see guest list. Requires an access token of an Admin of the Event. |
event_id |
decimal |
itgen_facebook_event_id |
☐ |
The event ID. |
event_interested_count |
int32 |
itgen_facebook_event_interested_count |
☐ |
Number of people interested in the event. |
event_is_canceled |
boolean |
itgen_facebook_event_is_canceled |
☐ |
Whether or not the event has been marked as canceled. |
event_is_draft |
boolean |
itgen_facebook_event_is_draft |
☐ |
Whether the event is in draft mode or published. Requires an access token of an Admin of the Event. |
event_is_page_owned |
boolean |
itgen_facebook_event_is_page_owned |
☐ |
Whether the event is created by page or not. |
event_maybe_count |
int32 |
itgen_facebook_event_maybe_count |
☐ |
Number of people who may be going to the event. |
event_name |
string |
itgen_facebook_event_name |
☐ |
Event name. |
event_noreply_count |
int32 |
itgen_facebook_event_noreply_count |
☐ |
Number of people who did not reply to the event. |
event_scheduled_publish_time |
string |
itgen_facebook_event_scheduled_publish_time |
☐ |
Time when event is scheduled to be published. |
event_start_time |
string |
itgen_facebook_event_start_time |
☐ |
Start time. |
event_ticket_uri |
string |
itgen_facebook_event_ticket_uri |
☐ |
The link users can visit to buy a ticket to this event. |
event_ticket_uri_start_sales_time |
string |
itgen_facebook_event_ticket_uri_start_sales_time |
☐ |
Time when tickets go on sale. |
event_ticketing_privacy_uri |
string |
itgen_facebook_event_ticketing_privacy_uri |
☐ |
URI to seller's privacy policy for ticket purchases. |
event_ticketing_terms_uri |
string |
itgen_facebook_event_ticketing_terms_uri |
☐ |
URI to seller's terms of service for ticket purchases. |
event_timezone |
string |
itgen_facebook_event_timezone |
☐ |
Timezone. |
event_type |
string |
itgen_facebook_event_type |
☐ |
The type of the event: private, public, group, community. |
event_updated_time |
datetime |
itgen_facebook_event_updated_time |
☐ |
Last update time (ISO 8601 formatted). |
format |
string |
itgen_facebook_format |
☐ |
List of different formats of the video. |
icon |
string |
Icon |
☐ |
The icon that Facebook displays when videos are published to the feed. |
id |
decimal |
ID |
☐ |
Video ID. |
is_crosspost_video |
boolean |
itgen_facebook_is_crosspost_video |
☐ |
Whether the video is crossposted from other page. |
is_crossposting_eligible |
boolean |
itgen_facebook_is_crossposting_eligible |
☐ |
Specifies if the video is eligible for crossposting. Page access-token is required to query this field. |
is_episode |
boolean |
itgen_facebook_is_episode |
☐ |
Whether this video is episode or not. |
is_instagram_eligible |
boolean |
itgen_facebook_is_instagram_eligible |
☐ |
Whether the video is eligible to be promoted on Instagram. |
is_reference_only |
boolean |
itgen_facebook_is_reference_only |
☐ |
Whether the video is exclusively used for copyright monitoring. |
length |
double |
itgen_facebook_length |
☐ |
Duration of this video in seconds. |
live_status |
string |
itgen_facebook_live_status |
☐ |
The live status of the video. |
permalink_url |
string |
itgen_facebook_permalink_url |
☐ |
URL to the permalink page of the video. |
picture |
string |
Picture |
☐ |
The URL for the thumbnail picture of the video. |
place_id |
decimal |
Place ID |
☐ |
The place ID. |
place_name |
string |
Place Name |
☐ |
Name. |
place_overall_rating |
double |
itgen_facebook_place_overall_rating |
☐ |
Overall Rating of Place, on a 5-star scale. 0 means not enough data to get a combined rating. |
premiere_living_room_status |
string |
itgen_facebook_premiere_living_room_status |
☐ |
The status of the Premiere Watch Party, if any. |
privacy_allow |
string |
itgen_facebook_privacy_allow |
☐ |
The IDs of the specific users or friend lists that can see the object (as a comma-separated string). |
privacy_deny |
string |
itgen_facebook_privacy_deny |
☐ |
The IDs of the specific users or friend lists that cannot see the object (as a comma-separate string). |
privacy_description |
string |
itgen_facebook_privacy_description |
☐ |
A description of the privacy settings. For custom settings, it can contain names of users, networks and friend lists. |
privacy_friends |
string |
itgen_facebook_privacy_friends |
☐ |
Which category of users can see the object. This field is only set when the 'value' field is CUSTOM. |
privacy_networks |
string |
itgen_facebook_privacy_networks |
☐ |
The ID of the network that can see the object, or 1 for all of the user's networks. |
privacy_value |
string |
itgen_facebook_privacy_value |
☐ |
The privacy value for the object. |
published |
boolean |
itgen_facebook_published |
☐ |
Whether a post about this video is published. The post is not scheduled, draft, or ads_post. |
scheduled_publish_time |
datetime |
itgen_facebook_scheduled_publish_time |
☐ |
The time that the video is scheduled to publish. |
source |
string |
Source |
☐ |
A URL to the raw, playable video file. |
status_processing_progress |
int32 |
itgen_facebook_status_processing_progress |
☐ |
Video processing progress in percent [int 0 to 100]. |
status_video_status |
string |
itgen_facebook_status_video_status |
☐ |
Status of a video, either 'ready' (uploaded, encoded, thumbnails extracted), 'processing' (not ready yet) or 'error' (processing failed). |
title |
string |
itgen_facebook_title |
☐ |
The video title or caption. |
universal_video_id |
string |
itgen_facebook_universal_video_id |
☐ |
The publishers asset management code for this video. |
updated_time |
datetime |
Updated |
☐ |
The last time the video or its caption was updated. |
Generated 11-01-2019 15:44 on version 17.30.0-PROD+1821.