AdInsightsAssets
Queries an Ad Report with asset breakdowns. Accessing Ad Report information requires the ads_read permission.
Columns
Name | Type | Description |
Target | String | The Id of the Ad or Ad Set for which to get insights. Note that the asset breakdowns cannot target an Ad Account. |
DatePreset | String | An alternative to specifying the DateStart and DateEnd. A date range is automatically calculated based on the specified preset value.
使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month |
DateStart | Date | The starting date to retrieve insights. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field. |
DateEnd | Date | The ending date to retrieve insights. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field. |
TimeIncrement | String | The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.
デフォルト値は1です。 |
Level | String | The level to represent the results at.
使用できる値は次のとおりです。ad, adset, campaign, account |
AccountCurrency | String | The currency that is being used by the ad account. |
ActionAttributionWindows | String | A comma separated list that determines what is the attribution window for the actions. For example, 28d_click means the API returns all actions that happened 28 days after someone clicked on the ad. The default option means [1d_view,28d_click]. Possible values include 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click, default. |
AdAccountId | String | The Id of the Ad Account that is associated with the report row. |
AdAccountName | String | The name of the Ad Account that is associated with the report row. |
CampaignId | String | The Id of the Campaign that is associated with the report row. |
CampaignName | String | The name of the Campaign that is associated with the report row. |
AdSetId | String | The Id of the Ad Set that is associated with the report row. |
AdSetName | String | The name of the Ad Set that is associated with the report row. |
AdId | String | The Id of the Ad that is associated with the report row. |
AdName | String | The name of the Ad that is associated with the report row. |
BuyingType | String | The method by which target ads are paid for in your campaigns. |
Clicks | Long | The total number of clicks on your ad. Depending on what you're promoting, this can include Page likes, event responses or app installs. In the Facebook UI, this is the Clicks (All) field. |
ConversionRateRanking | String | The conversion rate ranking. |
CostPerEstimatedAdRecallers | Decimal | The average cost per additional person that we estimate will recall seeing your ad if asked within 2 days. |
CostPerInlineLinkClick | Decimal | The average cost per click on links in the ad. |
CostPerInlinePostEngagement | Decimal | The average cost per engagement on the post. |
CostPerUniqueClick | Decimal | The average cost per unique click for these ads, calculated as the amount spent divided by the number of unique clicks received. |
CostPerUniqueInlineLinkClick | Decimal | The average you paid for each unique inline link click. |
CPC | Decimal | The average cost per click for these ads, calculated as the amount spent divided by the number of clicks received. |
CPM | Decimal | The average cost that you've paid to have 1,000 impressions on your ad. |
CPP | Decimal | The average cost that you've paid to have your ad served to 1,000 unique people. |
CTR | Double | The number of clicks you received divided by the number of impressions. In the Facebook UI, this is the CTR (All) % field. |
EstimatedAdRecallRate | Double | The estimated number of people who recall your ad divided by the number of people your ad reached. |
EstimatedAdRecallers | Double | The additional number of people that we estimate will remember seeing your ads if asked within 2 days. |
Frequency | Double | The average number of times that your ad was served to each person. |
Impressions | Long | The number of times that your ad was served. On our mobile apps an ad is counted as served the first time it's viewed. On all other Facebook interfaces, an ad is served the first time it's placed in a person's News Feed or each time it's placed in the right column. |
InlineLinkClicks | Long | Total number of clicks on links in the ad. |
InlineLinkClicksCounter | Double | The click-through rate for inline clicks to link. |
InlinePostEngagement | Long | The total number of engagements on the post. |
InstantExperienceClicksToOpen | Long | instant_experience_clicks_to_open |
InstantExperienceClicksToStart | Long | instant_experience_clicks_to_start |
InstantExperienceOutboundClicks | Long | instant_experience_outbound_clicks |
Objective | String | The objective you selected for your campaign. Your objective reflects the goal you want to achieve with your advertising. |
QualityRanking | String | The quality ranking. |
Reach | Long | The number of people your ad was served to. |
Spend | Decimal | The total amount you've spent so far. |
UniqueClicks | Long | The total number of unique people who have clicked on your ad. For example, if 3 people click on the same ad 5 times, it counts as 3 unique clicks. |
UniqueCTR | Double | The number of people who clicked on your ad divided by the number of people you reached. For example, if you received 20 unique clicks and your ad was served to 1,000 unique people, your unique click-through rate would be 2%. |
UniqueInlineLinkClicks | Long | The number of unique inline link clicks that your ad got. In the Facebook UI, this is the Unique Clicks to Link field. |
UniqueInlineLinkClickCounter | Double | The click-through rate for unique inline clicks to link. |
UniqueLinkClicksCounter | Double | The unique click-through rate for clicks to link. The number of people who clicked on the link in your ad that directs people off Facebook divided by the number of people you reached. Example: if you received 20 unique clicks to link and your ad was shown to 1,000 unique people, your unique click-through rate would be 2%. |
Checkins | Int | The number of checkins attributed to the Ad. |
EventResponses | Int | The number of event responses attributed to the Ad. |
LinkClicks | Int | The number of link clicks attributed to the Ad. |
OfferSaves | Int | The number of receive offers attributed to the Ad. |
OutboundClicks | Int | The number of outbound clicks attributed to the Ad. |
PageEngagements | Int | The number of page enagements attributed to the Ad. |
PageLikes | Int | The number of page likes attributed to the Ad. |
PageMentions | Int | The number of page mentions attributed to the Ad. |
PagePhotoViews | Int | The number of photo views attributed to the Ad. |
PostComments | Int | The number of post comments attributed to the Ad. |
PostEngagements | Int | The number of post engagements attributed to the Ad. |
PostShares | Int | The number of post shares attributed to the Ad. |
PostReactions | Int | The number of post reactions attributed to the Ad. |
PageTabViews | Int | The number of tab views attributed to the Ad. |
Video3SecondViews | Int | The number of video views attributed to the Ad. Views count if at least 3 seconds or the entire video (if the video is less than 3 seconds) were played. |
PixelAddToCart | Int | Pixel adds to cart. |
PixelPurchase | Int | Pixel purchases. |
Age | String | The age range for the metrics in this row. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
Gender | String | The gender for the metrics in this row. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
BodyAssetId | String | Body asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
BodyAssetText | String | Body asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
DescriptionAssetId | String | Description asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
DescriptionAssetText | String | Description asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
ImageAssetId | String | Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
ImageAssetHash | String | Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
ImageAssetUrl | String | Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
TitleAssetId | String | Title asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
TitleAssetText | String | Title asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
CallToActionAssetId | String | Call to action asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
CallToActionAssetName | String | Call to action asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
LinkUrlAssetId | String | Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
LinkUrlAssetWebsiteUrl | String | Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
LinkUrlAssetDisplayUrl | String | Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
VideoAssetId | String | Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
VideoAssetVideoId | String | Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
VideoAssetUrl | String | Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
VideoAssetThumbnailUrl | String | Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
VideoAssetVideoName | String | Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
AdFormatAsset | String | Ad format asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric. |
AdEffectiveStatus | String | An input only list of supported statuses when retrieving insights at a level lower than the Ad Account. See the values listed on AdStatus for an example of valid values. |
UseAsync | Boolean | A boolean indicating if an asynchronous call should be used for retrieving the insights. |
DefaultSummary | Boolean | A boolean indicating if we should get the default summary. |