GoogleAdsGoogleadsV25Services__SearchGoogleAdsFieldsResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/google-ads/json-schema/google-ads-google-ads-googleads-v25-services-search-google-ads-fields-response-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__SearchGoogleAdsFieldsResponse",
  "description": "Response message for GoogleAdsFieldService.SearchGoogleAdsFields.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-googleadsfields-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__SearchGoogleAdsFieldsResponse",
  "type": "object",
  "properties": {
    "nextPageToken": {
      "description": "Pagination token used to retrieve the next page of results. Pass the content of this string as the `page_token` attribute of the next request. `next_page_token` is not returned for the last page.",
      "type": "string"
    },
    "results": {
      "type": "array",
      "description": "The list of fields that matched the query.",
      "items": {
        "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__GoogleAdsField"
      }
    },
    "totalResultsCount": {
      "format": "int64",
      "description": "Total number of results that match the query ignoring the LIMIT clause.",
      "type": "string"
    }
  },
  "$defs": {
    "GoogleAdsGoogleadsV25Resources__GoogleAdsField": {
      "description": "A field or resource (artifact) used by GoogleAdsService.",
      "type": "object",
      "properties": {
        "category": {
          "x-enumDescriptions": [
            "Unspecified",
            "Unknown",
            "The described artifact is a resource.",
            "The described artifact is a field and is an attribute of a resource. Including a resource attribute field in a query may segment the query if the resource to which it is attributed segments the resource found in the FROM clause.",
            "The described artifact is a field and always segments search queries.",
            "The described artifact is a field and is a metric. It never segments search queries."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "RESOURCE",
            "ATTRIBUTE",
            "SEGMENT",
            "METRIC"
          ],
          "type": "string",
          "description": "Output only. The category of the artifact."
        },
        "typeUrl": {
          "type": "string",
          "description": "Output only. The URL of proto describing the artifact's data type."
        },
        "dataType": {
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "BOOLEAN",
            "DATE",
            "DOUBLE",
            "ENUM",
            "FLOAT",
            "INT32",
            "INT64",
            "MESSAGE",
            "RESOURCE_NAME",
            "STRING",
            "UINT64"
          ],
          "description": "Output only. This field determines the operators that can be used with the artifact in WHERE clauses.",
          "type": "string",
          "x-enumDescriptions": [
            "Unspecified",
            "Unknown",
            "Maps to google.protobuf.BoolValue Applicable operators: =, !=",
            "Maps to google.protobuf.StringValue. It can be compared using the set of operators specific to dates however. Applicable operators: =, <, >, <=, >=, BETWEEN, DURING, and IN",
            "Maps to google.protobuf.DoubleValue Applicable operators: =, !=, <, >, IN, NOT IN",
            "Maps to an enum. It's specific definition can be found at type_url. Applicable operators: =, !=, IN, NOT IN",
            "Maps to google.protobuf.FloatValue Applicable operators: =, !=, <, >, IN, NOT IN",
            "Maps to google.protobuf.Int32Value Applicable operators: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN",
            "Maps to google.protobuf.Int64Value Applicable operators: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN",
            "Maps to a protocol buffer message type. The data type's details can be found in type_url. No operators work with MESSAGE fields.",
            "Maps to google.protobuf.StringValue. Represents the resource name (unique id) of a resource or one of its foreign keys. No operators work with RESOURCE_NAME fields.",
            "Maps to google.protobuf.StringValue. Applicable operators: =, !=, LIKE, NOT LIKE, IN, NOT IN",
            "Maps to google.protobuf.UInt64Value Applicable operators: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN"
          ]
        },
        "metrics": {
          "description": "Output only. This field lists the names of all metrics that are selectable with the described artifact when it is used in the FROM clause. It is only set for artifacts whose category is RESOURCE.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "sortable": {
          "description": "Output only. Whether the artifact can be used in a ORDER BY clause in search queries.",
          "type": "boolean"
        },
        "enumValues": {
          "description": "Output only. Values the artifact can assume if it is a field of type ENUM. This field is only set for artifacts of category SEGMENT or ATTRIBUTE.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "name": {
          "description": "Output only. The name of the artifact.",
          "type": "string"
        },
        "attributeResources": {
          "description": "Output only. The names of all resources that are selectable with the described artifact. Fields from these resources do not segment metrics when included in search queries. This field is only set for artifacts whose category is RESOURCE.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "isRepeated": {
          "type": "boolean",
          "description": "Output only. Whether the field artifact is repeated."
        },
        "segments": {
          "description": "Output only. This field lists the names of all artifacts, whether a segment or another resource, that segment metrics when included in search queries and when the described artifact is used in the FROM clause. It is only set for artifacts whose category is RESOURCE.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "selectable": {
          "description": "Output only. Whether the artifact can be used in a SELECT clause in search queries.",
          "type": "boolean"
        },
        "resourceName": {
          "description": "Output only. The resource name of the artifact. Artifact resource names have the form: `googleAdsFields/{name}`",
          "type": "string"
        },
        "filterable": {
          "description": "Output only. Whether the artifact can be used in a WHERE clause in search queries.",
          "type": "boolean"
        },
        "selectableWith": {
          "description": "Output only. The names of all resources, segments, and metrics that are selectable with the described artifact.",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      }
    }
  }
}