Reference

Post

EndpointDescription

/{ad-account-id}/ads

Create an ad.

/{business-id}/initiated_sharing_agreements

Approve or decline a pending business agreement request.

/{business-creative-folder-id}

Create and update a business creative folder.

/{business-id}/creative_folders

Provide a business creative folder.

/{business-id}/images

Upload images to a creative folder.

/{business-id}/videos

Upload videos to a creative folder.

/{business-creative-folder-id}/agencies

Add a partner to a creative folder.

/{business-creative-folder-id}/assigned_users

Get a list of people who have access to the business creative folder.

Read

EndpointDescription

/{business-creative-folder-id}

Get details about a business creative folder.

/{business-id}/creative_folders

Get a list of business creative folders a business can access.

/{business-id}/creatives

Get business images and business videos of the business.

/{business-id}/initiated_sharing_agreement

Get a list of pending agreement requests.


This endpoint was reintroduced in May 2020. Previously, /initiated_sharing_agreement had been deprecated with the launch of Graph API V6.0.

/{business-image-id}

Get details for an image.

/{business-image-id}/insights

Get insights for a shared image.

/{business-video-id}

Get details of the shared video.

/{business-video-id}/insights

Get the insights for the shared video.

/{business-creative-folder-id}/agencies

Get a list of businesses who have access to your creative folder.

/{business-creative-folder-id}/assigned_users

Get a list of people who have access to your creative folder.

Delete

EndpointDescription
/{business-creative-folder-id}

Delete a creative folder.

/{business-creative-folder-id}/agencies

Remove a partner from the creative folder.

/{business-creative-folder-id}/assigned_users

Remove a user from the creative folder.

/{business-image-id}

Remove a shared image.

/{business-video-id}

Remove a shared video.

Permitted Tasks

Business User Permitted TaskDescription

CREATE_CONTENT

This user can create folders.

MANAGE_CONTENT

This user can manage creative folder assets.

MANAGE_PERMISSIONS

This user can manage business creative folder permissions.

VIEW_CONTENT

This user can view assets in a creative folder.

VIEW_INSIGHTS

This user can view the insights for a creative asset.

Insights

These metrics are under development.

Metric NameDescription
impressions

The number of times your image or video appeared in an ad.

inline_link_clicks

The number of clicks on links in your ad. Inline link clicks use a fixed 1-day-click attribution window.

video_play_actions

The number of times your video starts to play. We count this for each video impression, and exclude replays.

actions

The total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions. See this document for a full list of supported types.

video_thruplay_watched_actions

The number of times your video was played to completion, or for at least 15 seconds.

quality_ranking

A ranking of your ad's perceived quality. Quality is measured using an ad's feedback and the post-click experience. An ad is ranked against other ads that competed for the same audience.


Possible values include:

  • BELOW_AVERAGE_10
  • BELOW_AVERAGE_20
  • BELOW_AVERAGE_35
  • AVERAGE
  • ABOVE_AVERAGE
  • UNKNOWN, if there is not enough information about the ad.

This is related to ad relevance diagnostics.

The following breakdowns are available:

  • age
  • gender
  • country
  • objective
  • publisher_platform
  • platform_position
  • device_platform
  • optimization_goal