search | string | No | - | Search Google Ads GAQL resources, fields, metrics, or segments by name. Search values must be GAQL-style field fragments, usually lowercase snake_case with dots for prefixes. Do not use spaces: use ‘impression_share’ or ‘metrics.search_impression_share’ instead of ‘impression share’; Use without resource to discover metadata rows: {‘search’:‘conversion’,‘category’:‘METRIC’} finds conversion-related metrics; {‘search’:‘impression_share’,‘category’:‘METRIC’} finds impression-share metrics; {‘search’:‘campaign’,‘category’:‘RESOURCE’} finds campaign resources. Use with resource to check compatibility against a GAQL FROM resource: {‘resource’:‘campaign’,‘search’:‘segments.device’} checks whether the device segment is compatible with FROM campaign; {‘resource’:‘shopping_product’,‘search’:‘shopping_product.target_countries’} checks an attribute, including fields of joined resources such as campaign.name. For a broad compatibility lookup, leave search empty and set resource only. |
category | enum (ALL, RESOURCE, ATTRIBUTE, SEGMENT, METRIC) | No | ALL | Filter broad searches by GoogleAdsField category. Ignored when resource is supplied, since compatibility checks first resolve its exact RESOURCE metadata. Use RESOURCE to find valid FROM resources, METRIC to find metrics such as metrics.cost_micros, SEGMENT to find segments such as segments.date, ATTRIBUTE to find selectable attributes, and ALL to search all categories. |
resource | string | No | - | Optional GAQL FROM resource to inspect, such as campaign, ad_group, customer, or ad_group_ad. When provided, returns compatible metrics, segments, and attribute resources for that exact FROM resource. Attribute compatibility includes both attributed and segmenting resources. Examples: {‘resource’:‘campaign’} returns the full campaign compatibility list. |
include_selectable_with | boolean | No | False | Include the selectable_with compatibility list. This can be large, so leave it false unless you specifically need field-level compatibility details for a returned metric, segment, or attribute. |
limit | integer | No | 50 | Maximum number of metadata rows to return for broad searches. Resource-only and resource-plus-search checks usually return one row. |
