List Report Fields

​

When to Use It

• Discover available reporting metrics and dimensions
• Build custom report configurations
• Understand field definitions and data types
• Find specific fields for targeted analysis
• Validate field names before creating reports
• Explore new reporting capabilities
• Document available reporting schema

​

Inputs

​

Field Type Options

​

Field Categories

​

Output

{
  "report_fields": [
    {
      "field_id": "clicks",
      "field_name": "Clicks",
      "field_type": "metric",
      "data_type": "integer",
      "category": "performance",
      "description": "Number of clicks on your products in Shopping ads",
      "is_filterable": true,
      "is_sortable": true,
      "compatibility": ["all_reports"],
      "example_values": ["1234", "5678", "9012"]
    },
    {
      "field_id": "impressions",
      "field_name": "Impressions", 
      "field_type": "metric",
      "data_type": "integer",
      "category": "performance",
      "description": "Number of times your products were shown in Shopping ads",
      "is_filterable": true,
      "is_sortable": true,
      "compatibility": ["all_reports"],
      "example_values": ["12340", "56780", "90120"]
    },
    {
      "field_id": "product_title",
      "field_name": "Product Title",
      "field_type": "dimension",
      "data_type": "string",
      "category": "product",
      "description": "The title of the product as it appears in your product feed",
      "is_filterable": true,
      "is_sortable": true,
      "compatibility": ["product_performance", "shopping_performance"],
      "example_values": ["iPhone 15 Pro", "Samsung Galaxy S24", "Nike Air Max"]
    },
    {
      "field_id": "conversion_value",
      "field_name": "Conversion Value",
      "field_type": "metric",
      "data_type": "currency",
      "category": "financial",
      "description": "Total value of conversions attributed to your products",
      "is_filterable": true,
      "is_sortable": true,
      "compatibility": ["all_reports"],
      "example_values": ["1999.99", "599.50", "299.00"]
    },
    {
      "field_id": "date",
      "field_name": "Date",
      "field_type": "dimension",
      "data_type": "date",
      "category": "temporal",
      "description": "The date for which the data is reported",
      "is_filterable": true,
      "is_sortable": true,
      "compatibility": ["all_reports"],
      "example_values": ["2024-03-15", "2024-03-14", "2024-03-13"]
    }
  ],
  "summary": {
    "total_fields": 5,
    "total_metrics": 3,
    "total_dimensions": 2,
    "categories": {
      "performance": 2,
      "financial": 1,
      "product": 1,
      "temporal": 1
    }
  },
  "field_compatibility": {
    "all_reports": ["clicks", "impressions", "conversion_value", "date"],
    "product_performance": ["product_title"],
    "shopping_performance": ["product_title"]
  }
}

​

Field Properties:

​

Credit Cost

• Cost per run: 0 credits (Free)

​

Common Workflows

[List Report Fields] → [Select Relevant Fields] → [Plan Report Structure] → [Build Custom Report]

[List Report Fields] → [Search by Keywords] → [Review Field Definitions] → [Document Schema]

[List Report Fields] → [Validate Field Names] → [Check Compatibility] → [Fix Report Configuration]

[List Report Fields] → [Export Field List] → [Generate Documentation] → [Share with Team]

​

Field Categories

​

Performance Metrics

• Clicks: Product clicks in Shopping ads
• Impressions: Times products were shown
• CTR: Click-through rate percentage
• Position: Average ad position
• View-through Conversions: Indirect conversions

​

Financial Metrics

• Conversion Value: Total conversion revenue
• Cost: Total advertising cost
• CPC: Cost per click
• ROAS: Return on ad spend
• Revenue: Total sales revenue

​

Product Dimensions

• Product ID: Unique product identifier
• Product Title: Product name
• Brand: Product brand/manufacturer
• Category: Product category
• Product Type: Your product classification

​

Geographic Dimensions

• Country: Country where ad was shown
• Region: Geographic region
• City: City location
• Metro Area: Metropolitan area

​

Temporal Dimensions

• Date: Daily breakdown
• Week: Weekly aggregation
• Month: Monthly view
• Quarter: Quarterly analysis
• Year: Annual comparison

​

Use Cases

​

Custom Report Building

- Search for performance metrics
- Find relevant product dimensions
- Check field compatibility
- Build optimized report structure

​

Data Exploration

- Browse all available fields
- Understand data types and formats
- Explore new reporting capabilities
- Plan advanced analysis workflows

​

Report Troubleshooting

- Validate field names and IDs
- Check field compatibility
- Understand filtering limitations
- Resolve data type conflicts

​

Team Training

- Generate field documentation
- Share field definitions and examples
- Explain reporting capabilities
- Standardize field usage across team

​

Field Selection Guide

​

For Performance Analysis:

• clicks - Traffic measurement
• impressions - Visibility tracking
• ctr - Efficiency metric
• conversions - Success measurement
• conversion_rate - Performance indicator

​

For Financial Analysis:

• conversion_value - Total revenue
• cost - Advertising spend
• roas - Return on investment
• cpc - Cost efficiency
• revenue_per_click - Value metric

​

For Product Analysis:

• product_title - Product identification
• brand - Brand performance
• category - Category analysis
• product_type - Classification
• condition - Product condition

​

For Trend Analysis:

• date - Daily trends
• week - Weekly patterns
• month - Monthly comparison
• quarter - Seasonal analysis
• year - Annual trends

​

Search and Filter Tips

​

Effective Search Strategies:

• Use specific keywords related to your analysis needs
• Search by category to find related fields
• Look for field descriptions to understand data meaning
• Check compatibility before using fields in reports

​

Common Search Terms:

• “conversion” - Find all conversion-related metrics
• “product” - Discover product attribute dimensions
• “cost” - Locate financial metrics
• “date” - Find temporal dimensions
• “brand” - Identify brand-related fields

​

Filter Applications:

• Filter by metric type for performance analysis
• Filter by dimension type for segmentation
• Filter by category for focused discovery
• Filter by compatibility for specific report types

​

Tips

• Explore regularly - new fields are added periodically
• Use search function to quickly find relevant fields
• Read descriptions carefully to understand data meaning
• Note compatibility requirements for report building

• Start with key metrics then add supporting dimensions
• Check field compatibility before finalizing report structure
• Consider data types when planning filters and calculations
• Document field choices for team consistency

• Use field IDs in API calls for consistency
• Validate field availability before building automated reports
• Keep field lists updated as new fields become available
• Share field knowledge across your team

• Reference field schema when building reports
• Use for report validation and troubleshooting
• Combine with actual reporting for complete workflows
• Document field usage for future reference