Report data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
currency | string | No | |
metrics | AdsReportMetrics[] | No | |
metrics[].value | number | No | |
metrics[].type | enum | No | Values: CLICKS, IMPRESSIONS, CONVERSIONS, COST, CTR, CPC, CONVERSION_VALUE, CPA, ROAS, CPM, ECPM, ENGAGEMENT, VIDEO_COMPLETIONS, VIDEO_VIEWS, LEADS, ENGAGEMENTS, SAVES, LIKES, SHARES, COMMENTS, FOLLOWS, POST_CLICK_CONVERSIONS, VIEW_THROUGH_CONVERSIONS, ALL_CONVERSIONS, ALL_CONVERSION_VALUE, INTERACTIONS, REVENUE, MEDIA_COST, TOTAL_MEDIA_COST, VIDEO_PLAYS, VIDEO_QUARTILE_25, VIDEO_QUARTILE_50, VIDEO_QUARTILE_75, VIDEO_QUARTILE_100, VIDEO_AVG_TIME_WATCHED, VIDEO_THRUPLAY, VIEWABLE_IMPRESSIONS, MEASURABLE_IMPRESSIONS, VIEWABILITY_RATE, BILLABLE_IMPRESSIONS, DATA_FEES, PLATFORM_FEES, PROFIT, LANDING_PAGE_CLICKS, LEAD_FORM_OPENS, AD_UNIT_CLICKS, CARD_CLICKS, CARD_IMPRESSIONS, COMMENT_LIKES, COMPANY_PAGE_CLICKS, ACTION_CLICKS, TEXT_URL_CLICKS, OTHER_ENGAGEMENTS, OPENS, TOTAL_ENGAGEMENTS, UNIQUE_IMPRESSIONS, UNIQUE_CLICKS, VIRAL_IMPRESSIONS, VIRAL_CLICKS, VIRAL_LIKES, VIRAL_COMMENTS, VIRAL_SHARES, VIRAL_FOLLOWS, VIRAL_VIDEO_PLAYS, VIRAL_VIDEO_VIEWS, VIRAL_VIDEO_COMPLETIONS, VIRAL_VIDEO_QUARTILE_25, VIRAL_VIDEO_QUARTILE_50, VIRAL_VIDEO_QUARTILE_75, VIRAL_LEADS, VIRAL_LEAD_FORM_OPENS, VIRAL_LANDING_PAGE_CLICKS, VIRAL_CONVERSIONS, VIRAL_POST_CLICK_CONVERSIONS, VIRAL_VIEW_THROUGH_CONVERSIONS, VIRAL_ENGAGEMENTS, GMAIL_SECONDARY_CLICKS, AVERAGE_CPV, VIDEO_VIEWS_FROM_SEARCH, CROSS_DEVICE_CONVERSIONS, ABSOLUTE_TOP_IMPRESSION_SHARE, TOP_IMPRESSION_SHARE, ABSOLUTE_TOP_IMPRESSION_RATE_PERCENT, TOP_IMPRESSION_RATE_PERCENT, VIDEO_FULLSCREENS, VIDEO_PAUSES, VIDEO_MUTES, VIDEO_SKIPS, COMPANION_CLICKS, COMPANION_VIEWS, ACTIVE_VIEW_AVG_TIME, ELIGIBLE_IMPRESSIONS, EARNED_VIEWS, UNIQUE_VIEWERS, COST_USD, VIRAL_CARD_CLICKS, VIRAL_CARD_IMPRESSIONS, VIRAL_COMPANY_PAGE_CLICKS, VIRAL_VIDEO_FULLSCREENS, VIRAL_OTHER_ENGAGEMENTS, LEAD_GEN_CONTACT_SHARES, LEAD_GEN_INTERESTED_CLICKS, CM360_POST_CLICK_REVENUE, CM360_POST_VIEW_REVENUE, SCROLLS, MEDIA_FEE_1, MEDIA_FEE_2, MEDIA_FEE_3, MEDIA_FEE_4, MEDIA_FEE_5, ACTIVE_VIEW_DIST_UNMEASURABLE, ACTIVE_VIEW_DIST_UNVIEWABLE, ACTIVE_VIEW_DIST_VIEWABLE, ACTIVE_VIEW_AUDIBLE_VISIBLE_COMPLETE, ACTIVE_VIEW_VISIBLE_10S, NOT_MEASURABLE_IMPRESSIONS, NOT_VIEWABLE_IMPRESSIONS, 1D_VIEW, 1D_CLICK, 7D_VIEW, 7D_CLICK, 14D_CLICK, 28D_VIEW, 28D_CLICK, 30D_CLICK, VISITS, AUDIO_MUTES |
metrics[].dimension | enum | No | Values: DATE, PLATFORM, PLATFORM_POSITION, DEVICE |
metrics[].dimension_value | string | No | |
metrics[].campaign | AdsReportMetrics_campaign | No | |
metrics[].campaign.id | string | No | |
metrics[].campaign.created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metrics[].campaign.updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metrics[].campaign.name | string | No | |
metrics[].campaign.organization_id | string | No | |
metrics[].campaign.status | enum | No | Values: UNSPECIFIED, ACTIVE, PAUSED, ARCHIVED, DRAFT, SCHEDULED_FOR_DELETION, PROCESSING, PROCESSING_FAILED |
metrics[].campaign.effective_status | enum | No | read-only; controlled by the provider (whether/why the campaign can serve), unlike the user-managed status Values: UNSPECIFIED, SERVING, LIMITED, LEARNING, PAUSED, PENDING, ENDED, MISCONFIGURED, NOT_ELIGIBLE, ARCHIVED, REMOVED |
metrics[].campaign.start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metrics[].campaign.end_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metrics[].campaign.budget_amount | number | No | |
metrics[].campaign.budget_period | enum | No | Values: DAILY, MONTHLY, TOTAL, LIFETIME |
metrics[].campaign.budget_unit | enum | No | Values: UNSPECIFIED, CURRENCY, IMPRESSIONS |
metrics[].campaign.total_spend_amount | number | No | |
metrics[].campaign.targeting | AdsReportMetrics_campaign_targeting | No | |
metrics[].campaign.targeting.geographic | AdsReportMetrics_campaign_targeting_geographic | No | |
metrics[].campaign.targeting.geographic.countries | TargetRef[] | No | |
metrics[].campaign.targeting.geographic.countries[].id | string | No | |
metrics[].campaign.targeting.geographic.countries[].name | string | No | |
metrics[].campaign.targeting.geographic.regions | TargetRef[] | No | |
metrics[].campaign.targeting.geographic.regions[].id | string | No | |
metrics[].campaign.targeting.geographic.regions[].name | string | No | |
metrics[].campaign.targeting.geographic.cities | CityTarget[] | No | |
metrics[].campaign.targeting.geographic.cities[].id | string | Yes | |
metrics[].campaign.targeting.geographic.cities[].name | string | No | |
metrics[].campaign.targeting.geographic.cities[].radius | number | No | |
metrics[].campaign.targeting.geographic.cities[].radius_unit | enum | No | Values: MILES, KILOMETERS |
metrics[].campaign.targeting.geographic.postal_codes | TargetRef[] | No | |
metrics[].campaign.targeting.geographic.postal_codes[].id | string | No | |
metrics[].campaign.targeting.geographic.postal_codes[].name | string | No | |
metrics[].campaign.targeting.geographic.us_dmas | TargetRef[] | No | |
metrics[].campaign.targeting.geographic.us_dmas[].id | string | No | |
metrics[].campaign.targeting.geographic.us_dmas[].name | string | No | |
metrics[].campaign.targeting.geographic.excluded_countries | TargetRef[] | No | |
metrics[].campaign.targeting.geographic.excluded_countries[].id | string | No | |
metrics[].campaign.targeting.geographic.excluded_countries[].name | string | No | |
metrics[].campaign.targeting.geographic.excluded_regions | TargetRef[] | No | |
metrics[].campaign.targeting.geographic.excluded_regions[].id | string | No | |
metrics[].campaign.targeting.geographic.excluded_regions[].name | string | No | |
metrics[].campaign.targeting.geographic.excluded_cities | CityTarget[] | No | |
metrics[].campaign.targeting.geographic.excluded_cities[].id | string | Yes | |
metrics[].campaign.targeting.geographic.excluded_cities[].name | string | No | |
metrics[].campaign.targeting.geographic.excluded_cities[].radius | number | No | |
metrics[].campaign.targeting.geographic.excluded_cities[].radius_unit | enum | No | Values: MILES, KILOMETERS |
metrics[].campaign.targeting.geographic.excluded_postal_codes | TargetRef[] | No | |
metrics[].campaign.targeting.geographic.excluded_postal_codes[].id | string | No | |
metrics[].campaign.targeting.geographic.excluded_postal_codes[].name | string | No | |
metrics[].campaign.targeting.geographic.excluded_us_dmas | TargetRef[] | No | |
metrics[].campaign.targeting.geographic.excluded_us_dmas[].id | string | No | |
metrics[].campaign.targeting.geographic.excluded_us_dmas[].name | string | No | |
metrics[].campaign.targeting.geographic.location_types | enum[] | No | Values: HOME, RECENT, TRAVEL |
metrics[].campaign.targeting.geographic.presence_type | enum | No | Values: PRESENCE, PRESENCE_OR_INTEREST |
metrics[].campaign.targeting.demographic | AdsReportMetrics_campaign_targeting_demographic | No | Demographic targeting (Meta: age_min, age_max, genders) |
metrics[].campaign.targeting.demographic.age_min | number | No | |
metrics[].campaign.targeting.demographic.age_max | number | No | |
metrics[].campaign.targeting.demographic.male | boolean | No | |
metrics[].campaign.targeting.demographic.female | boolean | No | |
metrics[].campaign.targeting.audience | AdsReportMetrics_campaign_targeting_audience | No | |
metrics[].campaign.targeting.audience.custom_audiences | TargetRef[] | No | |
metrics[].campaign.targeting.audience.custom_audiences[].id | string | No | |
metrics[].campaign.targeting.audience.custom_audiences[].name | string | No | |
metrics[].campaign.targeting.audience.excluded_custom_audiences | TargetRef[] | No | |
metrics[].campaign.targeting.audience.excluded_custom_audiences[].id | string | No | |
metrics[].campaign.targeting.audience.excluded_custom_audiences[].name | string | No | |
metrics[].campaign.targeting.audience.lookalike_audiences | LookalikeAudience[] | No | |
metrics[].campaign.targeting.audience.lookalike_audiences[].id | string | Yes | |
metrics[].campaign.targeting.audience.lookalike_audiences[].name | string | No | |
metrics[].campaign.targeting.audience.lookalike_audiences[].similarity | number | No | |
metrics[].campaign.targeting.audience.lookalike_audiences[].source_audience_id | string | No | |
metrics[].campaign.targeting.audience.interests | TargetRef[] | No | |
metrics[].campaign.targeting.audience.interests[].id | string | No | |
metrics[].campaign.targeting.audience.interests[].name | string | No | |
metrics[].campaign.targeting.audience.excluded_interests | TargetRef[] | No | |
metrics[].campaign.targeting.audience.excluded_interests[].id | string | No | |
metrics[].campaign.targeting.audience.excluded_interests[].name | string | No | |
metrics[].campaign.targeting.audience.behaviors | TargetRef[] | No | |
metrics[].campaign.targeting.audience.behaviors[].id | string | No | |
metrics[].campaign.targeting.audience.behaviors[].name | string | No | |
metrics[].campaign.targeting.audience.excluded_behaviors | TargetRef[] | No | |
metrics[].campaign.targeting.audience.excluded_behaviors[].id | string | No | |
metrics[].campaign.targeting.audience.excluded_behaviors[].name | string | No | |
metrics[].campaign.targeting.audience.combination_spec | AudienceCombination[] | No | |
metrics[].campaign.targeting.audience.combination_spec[].interests | TargetRef[] | No | |
metrics[].campaign.targeting.audience.combination_spec[].behaviors | TargetRef[] | No | |
metrics[].campaign.targeting.audience.combination_spec[].references | TargetRef[] | No | |
metrics[].campaign.targeting.audience.combination_spec[].life_events | TargetRef[] | No | |
metrics[].campaign.targeting.placement | AdsReportMetrics_campaign_targeting_placement | No | |
metrics[].campaign.targeting.placement.platforms | string[] | No | |
metrics[].campaign.targeting.placement.facebook_positions | string[] | No | |
metrics[].campaign.targeting.placement.instagram_positions | string[] | No | |
metrics[].campaign.targeting.placement.messenger_positions | string[] | No | |
metrics[].campaign.targeting.placement.audience_network_positions | string[] | No | |
metrics[].campaign.targeting.device | AdsReportMetrics_campaign_targeting_device | No | |
metrics[].campaign.targeting.device.types | TargetRef[] | No | |
metrics[].campaign.targeting.device.types[].id | string | No | |
metrics[].campaign.targeting.device.types[].name | string | No | |
metrics[].campaign.targeting.device.user_device | TargetRef[] | No | |
metrics[].campaign.targeting.device.user_device[].id | string | No | |
metrics[].campaign.targeting.device.user_device[].name | string | No | |
metrics[].campaign.targeting.device.user_os | TargetRef[] | No | |
metrics[].campaign.targeting.device.user_os[].id | string | No | |
metrics[].campaign.targeting.device.user_os[].name | string | No | |
metrics[].campaign.targeting.device.carriers | TargetRef[] | No | |
metrics[].campaign.targeting.device.carriers[].id | string | No | |
metrics[].campaign.targeting.device.carriers[].name | string | No | |
metrics[].campaign.targeting.language | TargetRef[] | No | |
metrics[].campaign.targeting.language[].id | string | No | |
metrics[].campaign.targeting.language[].name | string | No | |
metrics[].campaign.targeting.content | AdsReportMetrics_campaign_targeting_content | No | |
metrics[].campaign.targeting.content.keywords | AdsKeyword[] | No | |
metrics[].campaign.targeting.content.keywords[].text | string | Yes | |
metrics[].campaign.targeting.content.keywords[].match_type | enum | No | Values: BROAD, PHRASE, EXACT |
metrics[].campaign.targeting.content.excluded_keywords | AdsKeyword[] | No | |
metrics[].campaign.targeting.content.excluded_keywords[].text | string | Yes | |
metrics[].campaign.targeting.content.excluded_keywords[].match_type | enum | No | Values: BROAD, PHRASE, EXACT |
metrics[].campaign.targeting.content.topics | TargetRef[] | No | |
metrics[].campaign.targeting.content.topics[].id | string | No | |
metrics[].campaign.targeting.content.topics[].name | string | No | |
metrics[].campaign.targeting.content.excluded_topics | TargetRef[] | No | |
metrics[].campaign.targeting.content.excluded_topics[].id | string | No | |
metrics[].campaign.targeting.content.excluded_topics[].name | string | No | |
metrics[].campaign.targeting.content.urls | string[] | No | |
metrics[].campaign.targeting.content.excluded_urls | string[] | No | |
metrics[].campaign.targeting.content.video | AdsReportMetrics_campaign_targeting_content_video | No | |
metrics[].campaign.targeting.content.video.youtube_videos | string[] | No | |
metrics[].campaign.targeting.content.video.excluded_youtube_videos | string[] | No | |
metrics[].campaign.targeting.content.video.youtube_channels | string[] | No | |
metrics[].campaign.targeting.content.video.excluded_youtube_channels | string[] | No | |
metrics[].campaign.targeting.content.video.positions | enum[] | No | Values: PREROLL, MIDROLL, POSTROLL, INSTREAM, OUTSTREAM |
metrics[].campaign.targeting.content.video.player_sizes | enum[] | No | Values: SMALL, LARGE, HD |
metrics[].campaign.targeting.content.video.durations | enum[] | No | Values: SHORT, MEDIUM, LONG |
metrics[].campaign.targeting.brand_safety | AdsReportMetrics_campaign_targeting_brand_safety | No | Brand safety (Meta: excluded_publisher_categories, etc.; Google |
metrics[].campaign.targeting.brand_safety.excluded_publisher_categories | string[] | No | |
metrics[].campaign.targeting.brand_safety.excluded_content_labels | string[] | No | Google Ads ContentLabelType |
metrics[].campaign.targeting.brand_safety.brand_safety_content_filter_levels | string[] | No | |
metrics[].campaign.targeting.brand_safety.publisher_visibility_categories | enum[] | No | Values: limited, standard, expanded |
metrics[].campaign.targeting.brand_safety.block_list_ids | string[] | No | |
metrics[].campaign.targeting.schedule | AdSchedule[] | No | |
metrics[].campaign.targeting.schedule[].day_of_week | enum | Yes | Values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY |
metrics[].campaign.targeting.schedule[].start_hour | number | Yes | 0-23 |
metrics[].campaign.targeting.schedule[].start_minute | number | No | 0, 15, 30, 45 |
metrics[].campaign.targeting.schedule[].end_hour | number | Yes | 0-24 (24 = end of day) |
metrics[].campaign.targeting.schedule[].end_minute | number | No | 0, 15, 30, 45 |
metrics[].campaign.targeting.schedule[].bid_modifier | number | No | 0.1-10.0 |
metrics[].campaign.targeting.optimization | AdsReportMetrics_campaign_targeting_optimization | No | Optimization (Meta: targeting_automation; Google: observation vs targeting mode) |
metrics[].campaign.targeting.optimization.mode | enum | No | Google: bid_only falsetrue Values: TARGETING, OBSERVATION |
metrics[].campaign.targeting.optimization.advantage_audience | boolean | No | |
metrics[].campaign.targeting.optimization.advantage_placements | boolean | No | |
metrics[].campaign.targeting.optimization.targeting_optimization_expansion_all | boolean | No | |
metrics[].campaign.goal | enum | No | Values: UNSPECIFIED, BRAND_AWARENESS, ENGAGEMENT, REACH, WEBSITE_TRAFFIC, LEADS, SALES, APP_PROMOTION |
metrics[].campaign.planned_spend_amount | number | No | |
metrics[].campaign.frequency_cap | AdsReportMetrics_campaign_frequency_cap | No | |
metrics[].campaign.frequency_cap.is_unlimited | boolean | No | |
metrics[].campaign.frequency_cap.time_unit | enum | No | Values: UNSPECIFIED, LIFETIME, MONTHS, WEEKS, DAYS, HOURS, MINUTES |
metrics[].campaign.frequency_cap.time_unit_count | number | No | |
metrics[].campaign.frequency_cap.max_impressions | number | No | |
metrics[].campaign.frequency_cap.max_views | number | No | |
metrics[].campaign.advertising_channel_type | enum | No | Values: TEXT, IMAGE, VIDEO, RESPONSIVE, SHOPPING, APP, CALL, CAROUSEL, SOCIAL, DISPLAY, SEARCH, AUDIO, YOUTUBE, NATIVE, CTV, DOOH, PERFORMANCE_MAX |
metrics[].campaign.campaign_budget_identifier | string | No | Resource name for existing/shared budget (Google) |
metrics[].campaign.currency | string | No | |
metrics[].campaign.category | string | No | Housing, employment, credit, NONE (Meta) |
metrics[].campaign.has_eu_political_ads | boolean | No | |
metrics[].campaign.labels | string[] | No | |
metrics[].campaign.kpi | AdsReportMetrics_campaign_kpi | No | |
metrics[].campaign.kpi.type | enum | No | Values: UNSPECIFIED, CPM, CPC, CPA, CTR, VIEWABILITY, CPIAVC, CPE, CPV, CLICK_CVR, IMPRESSION_CVR, VCPM, VTR, AUDIO_COMPLETION_RATE, VIDEO_COMPLETION_RATE, CPCL, CPCV, TOS10, MAXIMIZE_PACING, CUSTOM_IMPRESSION_VALUE_OVER_COST, OTHER |
metrics[].campaign.kpi.amount | number | No | |
metrics[].campaign.kpi.percentage | number | No | |
metrics[].campaign.kpi.string_value | string | No | |
metrics[].campaign.kpi.algorithm_id | string | No | |
metrics[].group | AdsReportMetrics_group | No | |
metrics[].group.id | string | No | |
metrics[].group.created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metrics[].group.updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metrics[].group.name | string | No | |
metrics[].group.parent_id | string | No | |
metrics[].group.campaign_id | string | No | |
metrics[].group.organization_id | string | No | |
metrics[].group.insertionorder_id | string | No | |
metrics[].group.status | enum | No | Values: UNSPECIFIED, ACTIVE, PAUSED, ARCHIVED, DRAFT, SCHEDULED_FOR_DELETION, PROCESSING, PROCESSING_FAILED |
metrics[].group.effective_status | enum | No | Values: UNSPECIFIED, SERVING, LIMITED, LEARNING, PAUSED, PENDING, ENDED, MISCONFIGURED, NOT_ELIGIBLE, ARCHIVED, REMOVED |
metrics[].group.targeting | AdsReportMetrics_group_targeting | No | |
metrics[].group.targeting.geographic | AdsReportMetrics_group_targeting_geographic | No | |
metrics[].group.targeting.geographic.countries | TargetRef[] | No | |
metrics[].group.targeting.geographic.countries[].id | string | No | |
metrics[].group.targeting.geographic.countries[].name | string | No | |
metrics[].group.targeting.geographic.regions | TargetRef[] | No | |
metrics[].group.targeting.geographic.regions[].id | string | No | |
metrics[].group.targeting.geographic.regions[].name | string | No | |
metrics[].group.targeting.geographic.cities | CityTarget[] | No | |
metrics[].group.targeting.geographic.cities[].id | string | Yes | |
metrics[].group.targeting.geographic.cities[].name | string | No | |
metrics[].group.targeting.geographic.cities[].radius | number | No | |
metrics[].group.targeting.geographic.cities[].radius_unit | enum | No | Values: MILES, KILOMETERS |
metrics[].group.targeting.geographic.postal_codes | TargetRef[] | No | |
metrics[].group.targeting.geographic.postal_codes[].id | string | No | |
metrics[].group.targeting.geographic.postal_codes[].name | string | No | |
metrics[].group.targeting.geographic.us_dmas | TargetRef[] | No | |
metrics[].group.targeting.geographic.us_dmas[].id | string | No | |
metrics[].group.targeting.geographic.us_dmas[].name | string | No | |
metrics[].group.targeting.geographic.excluded_countries | TargetRef[] | No | |
metrics[].group.targeting.geographic.excluded_countries[].id | string | No | |
metrics[].group.targeting.geographic.excluded_countries[].name | string | No | |
metrics[].group.targeting.geographic.excluded_regions | TargetRef[] | No | |
metrics[].group.targeting.geographic.excluded_regions[].id | string | No | |
metrics[].group.targeting.geographic.excluded_regions[].name | string | No | |
metrics[].group.targeting.geographic.excluded_cities | CityTarget[] | No | |
metrics[].group.targeting.geographic.excluded_cities[].id | string | Yes | |
metrics[].group.targeting.geographic.excluded_cities[].name | string | No | |
metrics[].group.targeting.geographic.excluded_cities[].radius | number | No | |
metrics[].group.targeting.geographic.excluded_cities[].radius_unit | enum | No | Values: MILES, KILOMETERS |
metrics[].group.targeting.geographic.excluded_postal_codes | TargetRef[] | No | |
metrics[].group.targeting.geographic.excluded_postal_codes[].id | string | No | |
metrics[].group.targeting.geographic.excluded_postal_codes[].name | string | No | |
metrics[].group.targeting.geographic.excluded_us_dmas | TargetRef[] | No | |
metrics[].group.targeting.geographic.excluded_us_dmas[].id | string | No | |
metrics[].group.targeting.geographic.excluded_us_dmas[].name | string | No | |
metrics[].group.targeting.geographic.location_types | enum[] | No | Values: HOME, RECENT, TRAVEL |
metrics[].group.targeting.geographic.presence_type | enum | No | Values: PRESENCE, PRESENCE_OR_INTEREST |
metrics[].group.targeting.demographic | AdsReportMetrics_group_targeting_demographic | No | Demographic targeting (Meta: age_min, age_max, genders) |
metrics[].group.targeting.demographic.age_min | number | No | |
metrics[].group.targeting.demographic.age_max | number | No | |
metrics[].group.targeting.demographic.male | boolean | No | |
metrics[].group.targeting.demographic.female | boolean | No | |
metrics[].group.targeting.audience | AdsReportMetrics_group_targeting_audience | No | |
metrics[].group.targeting.audience.custom_audiences | TargetRef[] | No | |
metrics[].group.targeting.audience.custom_audiences[].id | string | No | |
metrics[].group.targeting.audience.custom_audiences[].name | string | No | |
metrics[].group.targeting.audience.excluded_custom_audiences | TargetRef[] | No | |
metrics[].group.targeting.audience.excluded_custom_audiences[].id | string | No | |
metrics[].group.targeting.audience.excluded_custom_audiences[].name | string | No | |
metrics[].group.targeting.audience.lookalike_audiences | LookalikeAudience[] | No | |
metrics[].group.targeting.audience.lookalike_audiences[].id | string | Yes | |
metrics[].group.targeting.audience.lookalike_audiences[].name | string | No | |
metrics[].group.targeting.audience.lookalike_audiences[].similarity | number | No | |
metrics[].group.targeting.audience.lookalike_audiences[].source_audience_id | string | No | |
metrics[].group.targeting.audience.interests | TargetRef[] | No | |
metrics[].group.targeting.audience.interests[].id | string | No | |
metrics[].group.targeting.audience.interests[].name | string | No | |
metrics[].group.targeting.audience.excluded_interests | TargetRef[] | No | |
metrics[].group.targeting.audience.excluded_interests[].id | string | No | |
metrics[].group.targeting.audience.excluded_interests[].name | string | No | |
metrics[].group.targeting.audience.behaviors | TargetRef[] | No | |
metrics[].group.targeting.audience.behaviors[].id | string | No | |
metrics[].group.targeting.audience.behaviors[].name | string | No | |
metrics[].group.targeting.audience.excluded_behaviors | TargetRef[] | No | |
metrics[].group.targeting.audience.excluded_behaviors[].id | string | No | |
metrics[].group.targeting.audience.excluded_behaviors[].name | string | No | |
metrics[].group.targeting.audience.combination_spec | AudienceCombination[] | No | |
metrics[].group.targeting.audience.combination_spec[].interests | TargetRef[] | No | |
metrics[].group.targeting.audience.combination_spec[].behaviors | TargetRef[] | No | |
metrics[].group.targeting.audience.combination_spec[].references | TargetRef[] | No | |
metrics[].group.targeting.audience.combination_spec[].life_events | TargetRef[] | No | |
metrics[].group.targeting.placement | AdsReportMetrics_group_targeting_placement | No | |
metrics[].group.targeting.placement.platforms | string[] | No | |
metrics[].group.targeting.placement.facebook_positions | string[] | No | |
metrics[].group.targeting.placement.instagram_positions | string[] | No | |
metrics[].group.targeting.placement.messenger_positions | string[] | No | |
metrics[].group.targeting.placement.audience_network_positions | string[] | No | |
metrics[].group.targeting.device | AdsReportMetrics_group_targeting_device | No | |
metrics[].group.targeting.device.types | TargetRef[] | No | |
metrics[].group.targeting.device.types[].id | string | No | |
metrics[].group.targeting.device.types[].name | string | No | |
metrics[].group.targeting.device.user_device | TargetRef[] | No | |
metrics[].group.targeting.device.user_device[].id | string | No | |
metrics[].group.targeting.device.user_device[].name | string | No | |
metrics[].group.targeting.device.user_os | TargetRef[] | No | |
metrics[].group.targeting.device.user_os[].id | string | No | |
metrics[].group.targeting.device.user_os[].name | string | No | |
metrics[].group.targeting.device.carriers | TargetRef[] | No | |
metrics[].group.targeting.device.carriers[].id | string | No | |
metrics[].group.targeting.device.carriers[].name | string | No | |
metrics[].group.targeting.language | TargetRef[] | No | |
metrics[].group.targeting.language[].id | string | No | |
metrics[].group.targeting.language[].name | string | No | |
metrics[].group.targeting.content | AdsReportMetrics_group_targeting_content | No | |
metrics[].group.targeting.content.keywords | AdsKeyword[] | No | |
metrics[].group.targeting.content.keywords[].text | string | Yes | |
metrics[].group.targeting.content.keywords[].match_type | enum | No | Values: BROAD, PHRASE, EXACT |
metrics[].group.targeting.content.excluded_keywords | AdsKeyword[] | No | |
metrics[].group.targeting.content.excluded_keywords[].text | string | Yes | |
metrics[].group.targeting.content.excluded_keywords[].match_type | enum | No | Values: BROAD, PHRASE, EXACT |
metrics[].group.targeting.content.topics | TargetRef[] | No | |
metrics[].group.targeting.content.topics[].id | string | No | |
metrics[].group.targeting.content.topics[].name | string | No | |
metrics[].group.targeting.content.excluded_topics | TargetRef[] | No | |
metrics[].group.targeting.content.excluded_topics[].id | string | No | |
metrics[].group.targeting.content.excluded_topics[].name | string | No | |
metrics[].group.targeting.content.urls | string[] | No | |
metrics[].group.targeting.content.excluded_urls | string[] | No | |
metrics[].group.targeting.content.video | AdsReportMetrics_group_targeting_content_video | No | |
metrics[].group.targeting.content.video.youtube_videos | string[] | No | |
metrics[].group.targeting.content.video.excluded_youtube_videos | string[] | No | |
metrics[].group.targeting.content.video.youtube_channels | string[] | No | |
metrics[].group.targeting.content.video.excluded_youtube_channels | string[] | No | |
metrics[].group.targeting.content.video.positions | enum[] | No | Values: PREROLL, MIDROLL, POSTROLL, INSTREAM, OUTSTREAM |
metrics[].group.targeting.content.video.player_sizes | enum[] | No | Values: SMALL, LARGE, HD |
metrics[].group.targeting.content.video.durations | enum[] | No | Values: SHORT, MEDIUM, LONG |
metrics[].group.targeting.brand_safety | AdsReportMetrics_group_targeting_brand_safety | No | Brand safety (Meta: excluded_publisher_categories, etc.; Google |
metrics[].group.targeting.brand_safety.excluded_publisher_categories | string[] | No | |
metrics[].group.targeting.brand_safety.excluded_content_labels | string[] | No | Google Ads ContentLabelType |
metrics[].group.targeting.brand_safety.brand_safety_content_filter_levels | string[] | No | |
metrics[].group.targeting.brand_safety.publisher_visibility_categories | enum[] | No | Values: limited, standard, expanded |
metrics[].group.targeting.brand_safety.block_list_ids | string[] | No | |
metrics[].group.targeting.schedule | AdSchedule[] | No | |
metrics[].group.targeting.schedule[].day_of_week | enum | Yes | Values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY |
metrics[].group.targeting.schedule[].start_hour | number | Yes | 0-23 |
metrics[].group.targeting.schedule[].start_minute | number | No | 0, 15, 30, 45 |
metrics[].group.targeting.schedule[].end_hour | number | Yes | 0-24 (24 = end of day) |
metrics[].group.targeting.schedule[].end_minute | number | No | 0, 15, 30, 45 |
metrics[].group.targeting.schedule[].bid_modifier | number | No | 0.1-10.0 |
metrics[].group.targeting.optimization | AdsReportMetrics_group_targeting_optimization | No | Optimization (Meta: targeting_automation; Google: observation vs targeting mode) |
metrics[].group.targeting.optimization.mode | enum | No | Google: bid_only falsetrue Values: TARGETING, OBSERVATION |
metrics[].group.targeting.optimization.advantage_audience | boolean | No | |
metrics[].group.targeting.optimization.advantage_placements | boolean | No | |
metrics[].group.targeting.optimization.targeting_optimization_expansion_all | boolean | No | |
metrics[].group.bid_amount | number | No | |
metrics[].group.bid_strategy | AdsReportMetrics_group_bid_strategy | No | YOUTUBE_AND_PARTNERS |
metrics[].group.bid_strategy.type | enum | Yes | Values: FIXED_BID, MAXIMIZE_SPEND, PERFORMANCE_GOAL, YOUTUBE_AND_PARTNERS |
metrics[].group.bid_strategy.fixed_bid_amount | number | No | |
metrics[].group.bid_strategy.performance_goal_type | enum | No | Values: UNSPECIFIED, CPA, CPC, VIEWABLE_CPM, CUSTOM_ALGO, CIVA, IVO_TEN, AV_VIEWED, REACH |
metrics[].group.bid_strategy.performance_goal_amount | number | No | |
metrics[].group.bid_strategy.max_average_cpm_bid_amount | number | No | |
metrics[].group.bid_strategy.custom_bidding_algorithm_id | string | No | |
metrics[].group.bid_strategy.raise_bid_for_deals | boolean | No | |
metrics[].group.bid_strategy.youtube_and_partners_type | enum | No | Values: UNSPECIFIED, MANUAL_CPV, MANUAL_CPM, TARGET_CPA, TARGET_CPM, RESERVE_CPM, MAXIMIZE_LIFT, MAXIMIZE_CONVERSIONS, TARGET_CPV, TARGET_ROAS, MAXIMIZE_CONVERSION_VALUE |
metrics[].group.bid_strategy.youtube_and_partners_value | string | No | |
metrics[].group.bid_strategy.target_roas | number | No | Target ROAS e.g. 2.5 = 250% (Google) |
metrics[].group.budget_amount | number | No | |
metrics[].group.budget_period | enum | No | Values: DAILY, MONTHLY, TOTAL, LIFETIME |
metrics[].group.budget_allocation_type | enum | No | Values: UNSPECIFIED, AUTOMATIC, FIXED, UNLIMITED |
metrics[].group.start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metrics[].group.end_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metrics[].group.budget_unit | enum | No | Values: UNSPECIFIED, CURRENCY, IMPRESSIONS |
metrics[].group.budget_max_amount | number | No | |
metrics[].group.type | enum | No | Values: TEXT, IMAGE, VIDEO, RESPONSIVE, SHOPPING, APP, CALL, CAROUSEL, SOCIAL, DISPLAY, SEARCH, AUDIO, YOUTUBE, NATIVE, CTV, DOOH, PERFORMANCE_MAX |
metrics[].group.has_eu_political_ads | boolean | No | |
metrics[].group.pacing | AdsReportMetrics_group_pacing | No | |
metrics[].group.pacing.period | enum | No | Values: UNSPECIFIED, DAILY, FLIGHT |
metrics[].group.pacing.type | string | No | |
metrics[].group.pacing.daily_max_amount | number | No | |
metrics[].group.pacing.daily_max_impressions | number | No | |
metrics[].group.frequency_cap | AdsReportMetrics_group_frequency_cap | No | |
metrics[].group.frequency_cap.is_unlimited | boolean | No | |
metrics[].group.frequency_cap.time_unit | enum | No | Values: UNSPECIFIED, LIFETIME, MONTHS, WEEKS, DAYS, HOURS, MINUTES |
metrics[].group.frequency_cap.time_unit_count | number | No | |
metrics[].group.frequency_cap.max_impressions | number | No | |
metrics[].group.frequency_cap.max_views | number | No | |
metrics[].group.creative_ids | string[] | No | |
metrics[].group.optimization_goal | enum | No | Optimization goals for ads_group (cross-platform; platform-specific values allowed as pass-through) Values: REACH, IMPRESSIONS, LINK_CLICKS, LANDING_PAGE_VIEWS, CONVERSIONS, LEAD_GENERATION, APP_INSTALLS, APP_ENGAGEMENT, VIDEO_VIEWS, ENGAGEMENT, PAGE_LIKES, MESSAGES |
metrics[].group.billing_event | enum | No | Billing events for ads_group (what you pay for; cross-platform; platform-specific values allowed as pass-through) Values: IMPRESSIONS, LINK_CLICKS, VIDEO_VIEWS, APP_INSTALLS, ENGAGEMENT, PAGE_LIKES, MESSAGES, POST_ENGAGEMENT, PURCHASE, NONE |
metrics[].group.currency | string | No | |
metrics[].group.promoted | AdsPromoted[] | No | |
metrics[].group.promoted[].id | string | Yes | |
metrics[].group.promoted[].name | string | No | |
metrics[].group.promoted[].type | enum | Yes | Promoted entity types for ads_promoted list endpoint Values: PAGE_ID, APP_ID, STORE_URL, PIXEL_ID, CUSTOM_CONVERSION_ID, CATALOG_ID, PRODUCT_SET_ID, PRIORITIZED_SET_ID, EVENT_ID, OFFER_ID, LEAD_FORM_ID, MESSAGING_CHANNEL_ID, PRODUCT_ID, TWEET_ID, AD_GROUP_TYPE |
metrics[].group.language_locale | string | No | Language + region, ISO 639-1 with region (e.g. en-US); LinkedIn locale |
metrics[].group.creative_selection | enum | No | Creative rotation strategy (LinkedIn creativeSelection) Values: OPTIMIZED, ROUND_ROBIN |
metrics[].ad | AdsReportMetrics_ad | No | |
metrics[].ad.id | string | No | |
metrics[].ad.created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metrics[].ad.updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metrics[].ad.name | string | No | |
metrics[].ad.campaign_id | string | No | |
metrics[].ad.group_id | string | No | (reference to AdsGroup) |
metrics[].ad.organization_id | string | No | |
metrics[].ad.status | enum | No | Values: UNSPECIFIED, ACTIVE, PAUSED, ARCHIVED, DRAFT, SCHEDULED_FOR_DELETION, PROCESSING, PROCESSING_FAILED |
metrics[].ad.ad_type | enum | No | Values: TEXT, IMAGE, VIDEO, RESPONSIVE, SHOPPING, APP, CALL, CAROUSEL, SOCIAL, DISPLAY, SEARCH, AUDIO, YOUTUBE, NATIVE, CTV, DOOH, PERFORMANCE_MAX |
metrics[].ad.advertiser_name | string | No | |
metrics[].ad.creative_ids | string[] | No | |
metrics[].ad.creative_asset_url | string | No | |
metrics[].ad.ad_copy | string | No | |
metrics[].ad.headline | string | No | |
metrics[].ad.description | string | No | |
metrics[].ad.cta | string | No | |
metrics[].ad.final_url | string | No | |
metrics[].ad.display_url | string | No | |
metrics[].ad.path1 | string | No | |
metrics[].ad.path2 | string | No | |
metrics[].ad.promoted | AdsPromoted[] | No | |
metrics[].ad.promoted[].id | string | Yes | |
metrics[].ad.promoted[].name | string | No | |
metrics[].ad.promoted[].type | enum | Yes | Promoted entity types for ads_promoted list endpoint Values: PAGE_ID, APP_ID, STORE_URL, PIXEL_ID, CUSTOM_CONVERSION_ID, CATALOG_ID, PRODUCT_SET_ID, PRIORITIZED_SET_ID, EVENT_ID, OFFER_ID, LEAD_FORM_ID, MESSAGING_CHANNEL_ID, PRODUCT_ID, TWEET_ID, AD_GROUP_TYPE |
metrics[].ad.logo_creative_id | string | No | |
metrics[].creative | AdsReportMetrics_creative | No | |
metrics[].creative.id | string | No | |
metrics[].creative.created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metrics[].creative.updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metrics[].creative.name | string | No | |
metrics[].creative.campaign_id | string | No | |
metrics[].creative.group_id | string | No | (reference to AdsGroup) |
metrics[].creative.item_id | string | No | references Commerce Item ID (reference to CommerceItem) |
metrics[].creative.organization_id | string | No | |
metrics[].creative.status | enum | No | Values: UNSPECIFIED, ACTIVE, PAUSED, ARCHIVED, DRAFT, SCHEDULED_FOR_DELETION, PROCESSING, PROCESSING_FAILED |
metrics[].creative.creative_type | enum | No | Values: UNSPECIFIED, STANDARD, EXPANDABLE, VIDEO, NATIVE, AUDIO, PUBLISHER_HOSTED, ASSET_BASED, IMAGE, DOCUMENT, SHARE |
metrics[].creative.hosting_source | enum | No | Values: UNSPECIFIED, CM, THIRD_PARTY, HOSTED, RICH_MEDIA, PUBLISHER_HOSTED |
metrics[].creative.width | number | No | |
metrics[].creative.height | number | No | |
metrics[].creative.asset_urls | string[] | No | Hosted asset mode (best-effort, provider-specific |
metrics[].creative.link_url | string | No | Destination URL for creatives with links |
metrics[].creative.url_tags | string | No | Appended URL tracking params (e.g. utm_source=..&utm_medium=..); Meta url_tags, Google tracking template |
metrics[].creative.body | string | No | |
metrics[].creative.title | string | No | |
metrics[].creative.cta | string | No | |
metrics[].creative.third_party_tag | string | No | |
metrics[].creative.vast_tag_url | string | No | |
metrics[].creative.external_creative_reference | string | No | |
metrics[].creative.external_placement_reference | string | No | |
metrics[].creative.external_ad_reference | string | No | |
metrics[].creative.promoted | AdsPromoted[] | No | |
metrics[].creative.promoted[].id | string | Yes | |
metrics[].creative.promoted[].name | string | No | |
metrics[].creative.promoted[].type | enum | Yes | Promoted entity types for ads_promoted list endpoint Values: PAGE_ID, APP_ID, STORE_URL, PIXEL_ID, CUSTOM_CONVERSION_ID, CATALOG_ID, PRODUCT_SET_ID, PRIORITIZED_SET_ID, EVENT_ID, OFFER_ID, LEAD_FORM_ID, MESSAGING_CHANNEL_ID, PRODUCT_ID, TWEET_ID, AD_GROUP_TYPE |
metrics[].creative.path1 | string | No | Display URL path 1 (Microsoft RSA Path1) |
metrics[].creative.path2 | string | No | Display URL path 2 (Microsoft RSA Path2) |
metrics[].creative.data | string | No | |
metrics[].creative.labels | string[] | No | |
metrics[].insertionorder | AdsReportMetrics_insertionorder | No | |
metrics[].insertionorder.id | string | No | |
metrics[].insertionorder.created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metrics[].insertionorder.updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metrics[].insertionorder.name | string | No | |
metrics[].insertionorder.organization_id | string | No | |
metrics[].insertionorder.campaign_id | string | No | |
metrics[].insertionorder.status | enum | No | Values: UNSPECIFIED, ACTIVE, PAUSED, ARCHIVED, DRAFT, SCHEDULED_FOR_DELETION, PROCESSING, PROCESSING_FAILED |
metrics[].insertionorder.pacing | AdsReportMetrics_insertionorder_pacing | No | |
metrics[].insertionorder.pacing.period | enum | No | Values: UNSPECIFIED, DAILY, FLIGHT |
metrics[].insertionorder.pacing.type | string | No | |
metrics[].insertionorder.pacing.daily_max_amount | number | No | |
metrics[].insertionorder.pacing.daily_max_impressions | number | No | |
metrics[].insertionorder.frequency_cap | AdsReportMetrics_insertionorder_frequency_cap | No | |
metrics[].insertionorder.frequency_cap.is_unlimited | boolean | No | |
metrics[].insertionorder.frequency_cap.time_unit | enum | No | Values: UNSPECIFIED, LIFETIME, MONTHS, WEEKS, DAYS, HOURS, MINUTES |
metrics[].insertionorder.frequency_cap.time_unit_count | number | No | |
metrics[].insertionorder.frequency_cap.max_impressions | number | No | |
metrics[].insertionorder.frequency_cap.max_views | number | No | |
metrics[].insertionorder.kpi | AdsReportMetrics_insertionorder_kpi | No | |
metrics[].insertionorder.kpi.type | enum | No | Values: UNSPECIFIED, CPM, CPC, CPA, CTR, VIEWABILITY, CPIAVC, CPE, CPV, CLICK_CVR, IMPRESSION_CVR, VCPM, VTR, AUDIO_COMPLETION_RATE, VIDEO_COMPLETION_RATE, CPCL, CPCV, TOS10, MAXIMIZE_PACING, CUSTOM_IMPRESSION_VALUE_OVER_COST, OTHER |
metrics[].insertionorder.kpi.amount | number | No | |
metrics[].insertionorder.kpi.percentage | number | No | |
metrics[].insertionorder.kpi.string_value | string | No | |
metrics[].insertionorder.kpi.algorithm_id | string | No | |
metrics[].insertionorder.budget_unit | enum | No | Values: UNSPECIFIED, CURRENCY, IMPRESSIONS |
metrics[].insertionorder.budget_segments | AdsInsertionorderBudgetSegment[] | No | |
metrics[].insertionorder.budget_segments[].budget_amount | number | No | |
metrics[].insertionorder.budget_segments[].description | string | No | |
metrics[].insertionorder.budget_segments[].start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metrics[].insertionorder.budget_segments[].end_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metrics[].insertionorder.bid_strategy | AdsReportMetrics_insertionorder_bid_strategy | No | YOUTUBE_AND_PARTNERS |
metrics[].insertionorder.bid_strategy.type | enum | Yes | Values: FIXED_BID, MAXIMIZE_SPEND, PERFORMANCE_GOAL, YOUTUBE_AND_PARTNERS |
metrics[].insertionorder.bid_strategy.fixed_bid_amount | number | No | |
metrics[].insertionorder.bid_strategy.performance_goal_type | enum | No | Values: UNSPECIFIED, CPA, CPC, VIEWABLE_CPM, CUSTOM_ALGO, CIVA, IVO_TEN, AV_VIEWED, REACH |
metrics[].insertionorder.bid_strategy.performance_goal_amount | number | No | |
metrics[].insertionorder.bid_strategy.max_average_cpm_bid_amount | number | No | |
metrics[].insertionorder.bid_strategy.custom_bidding_algorithm_id | string | No | |
metrics[].insertionorder.bid_strategy.raise_bid_for_deals | boolean | No | |
metrics[].insertionorder.bid_strategy.youtube_and_partners_type | enum | No | Values: UNSPECIFIED, MANUAL_CPV, MANUAL_CPM, TARGET_CPA, TARGET_CPM, RESERVE_CPM, MAXIMIZE_LIFT, MAXIMIZE_CONVERSIONS, TARGET_CPV, TARGET_ROAS, MAXIMIZE_CONVERSION_VALUE |
metrics[].insertionorder.bid_strategy.youtube_and_partners_value | string | No | |
metrics[].insertionorder.bid_strategy.target_roas | number | No | Target ROAS e.g. 2.5 = 250% (Google) |
metrics[].insertionorder.reference | string | No | client's reference ID for the insertion order |
metrics[].keyword | AdsReportMetrics_keyword | No | |
metrics[].keyword.id | string | Yes | |
metrics[].keyword.name | string | No | |
metrics[].keyword.text | string | No | |
metrics[].keyword.match_type | string | No | |
metrics[].keyword.engine_id | string | No | |
metrics[].keyword.landing_page | string | No | |
metrics[].placement | AdsReportMetrics_placement | No | |
metrics[].placement.id | string | Yes | |
metrics[].placement.name | string | No | |
start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
organization_id | string | No |
Are we missing anything? Let us know