{
  "description": "Search Google Patents or fetch full patent records. Pick a mode and fill the matching fields.",
  "properties": {
    "assignees": {
      "default": [],
      "description": "Assignee or applicant names. The actor runs one search per name.",
      "editor": "stringList",
      "prefill": [],
      "title": "Assignees / companies",
      "type": "array"
    },
    "citationDepth": {
      "default": 1,
      "description": "How many citation hops to follow in byCitation mode: 1, 2 or 3.",
      "editor": "number",
      "maximum": 3,
      "minimum": 1,
      "prefill": 1,
      "title": "Citation depth",
      "type": "integer"
    },
    "citationDirection": {
      "default": "both",
      "description": "Which side of the citation graph to walk in byCitation mode.",
      "editor": "select",
      "enum": [
        "backward",
        "forward",
        "both"
      ],
      "enumTitles": [
        "Backward (prior art)",
        "Forward (cited by)",
        "Both"
      ],
      "prefill": "both",
      "title": "Citation direction",
      "type": "string"
    },
    "classifications": {
      "default": [],
      "description": "CPC codes or prefixes such as H04L9/06, G06N3/00, H01M10. Combined with a keyword query when both are set.",
      "editor": "stringList",
      "prefill": [],
      "title": "CPC classifications",
      "type": "array"
    },
    "countryCodes": {
      "default": [],
      "description": "Two-letter office codes: US, EP, WO, JP, CN, KR, DE, GB, FR, CA, AU, IN and more. Empty means all offices.",
      "editor": "stringList",
      "prefill": [],
      "title": "Patent offices",
      "type": "array"
    },
    "dateFrom": {
      "default": "",
      "description": "Earliest date, inclusive. Leave empty for no lower bound.",
      "editor": "textfield",
      "title": "Date from (YYYY-MM-DD)",
      "type": "string"
    },
    "dateTo": {
      "default": "",
      "description": "Latest date, inclusive. Leave empty for no upper bound.",
      "editor": "textfield",
      "title": "Date to (YYYY-MM-DD)",
      "type": "string"
    },
    "dateType": {
      "default": "priority",
      "description": "Which date the From and To fields apply to.",
      "editor": "select",
      "enum": [
        "priority",
        "filing",
        "publication"
      ],
      "enumTitles": [
        "Priority date",
        "Filing date",
        "Publication date"
      ],
      "prefill": "priority",
      "title": "Date field",
      "type": "string"
    },
    "detailLanguage": {
      "default": "en",
      "description": "Language of the patent page text. Google translates where available.",
      "editor": "select",
      "enum": [
        "en",
        "de",
        "fr",
        "es",
        "ja",
        "ko",
        "zh",
        "ru",
        "pt",
        "it",
        "ar",
        "nl",
        "sv",
        "fi",
        "no",
        "da"
      ],
      "enumTitles": [
        "English",
        "German",
        "French",
        "Spanish",
        "Japanese",
        "Korean",
        "Chinese",
        "Russian",
        "Portuguese",
        "Italian",
        "Arabic",
        "Dutch",
        "Swedish",
        "Finnish",
        "Norwegian",
        "Danish"
      ],
      "prefill": "en",
      "title": "Detail page language",
      "type": "string"
    },
    "documentLanguages": {
      "default": [],
      "description": "Original publication languages: ENGLISH, GERMAN, FRENCH, SPANISH, JAPANESE, KOREAN, CHINESE, RUSSIAN, PORTUGUESE, ITALIAN, ARABIC, DUTCH, SWEDISH, FINNISH, NORWEGIAN, DANISH. This filters documents; it does not translate them.",
      "editor": "stringList",
      "prefill": [],
      "title": "Document languages",
      "type": "array"
    },
    "fetchFullDetails": {
      "default": false,
      "description": "For search modes, also fetch each patent page for claims, legal status, citations, family and other detail fields.",
      "editor": "checkbox",
      "prefill": false,
      "title": "Fetch full details",
      "type": "boolean"
    },
    "grouping": {
      "default": "family",
      "description": "One row per patent family (Google's default) or one row per publication.",
      "editor": "select",
      "enum": [
        "family",
        "publication"
      ],
      "enumTitles": [
        "One row per family",
        "One row per publication"
      ],
      "prefill": "family",
      "title": "Result grouping",
      "type": "string"
    },
    "includeNonPatentLiterature": {
      "default": false,
      "description": "Also return Google Scholar non-patent literature rows for each keyword query.",
      "editor": "checkbox",
      "prefill": false,
      "title": "Include non-patent literature",
      "type": "boolean"
    },
    "includeSimilar": {
      "default": true,
      "description": "Google mixes similar documents into search results. Keep them (label matchType=similar) or drop them.",
      "editor": "checkbox",
      "prefill": true,
      "title": "Include similar documents",
      "type": "boolean"
    },
    "inventors": {
      "default": [],
      "description": "Inventor names. The actor runs one search per name.",
      "editor": "stringList",
      "prefill": [],
      "title": "Inventors",
      "type": "array"
    },
    "litigation": {
      "default": "ANY",
      "description": "Only patents with related litigation, only patents with no known litigation, or any.",
      "editor": "select",
      "enum": [
        "ANY",
        "YES",
        "NO"
      ],
      "enumTitles": [
        "Any",
        "Has related litigation",
        "No known litigation"
      ],
      "prefill": "ANY",
      "title": "Litigation filter",
      "type": "string"
    },
    "maxItems": {
      "default": 25,
      "description": "Hard cap on emitted records. Google Patents exposes about 1,000 results per query; use date, office or CPC filters to go deeper.",
      "editor": "number",
      "maximum": 10000,
      "minimum": 1,
      "prefill": 3,
      "title": "Max items",
      "type": "integer"
    },
    "maxItemsPerQuery": {
      "default": 0,
      "description": "Optional cap for each query / inventor / assignee / CPC search. 0 means only the global Max items cap applies.",
      "editor": "number",
      "maximum": 1000,
      "minimum": 0,
      "title": "Max items per query",
      "type": "integer"
    },
    "mode": {
      "default": "searchPatents",
      "description": "Which lookup path to use.",
      "editor": "select",
      "enum": [
        "searchPatents",
        "byPatent",
        "byInventor",
        "byAssignee",
        "byClassification",
        "byCitation",
        "byFamily",
        "byUrl"
      ],
      "enumTitles": [
        "Search by keyword and filters",
        "Lookup publication numbers",
        "Inventor portfolio",
        "Assignee / company portfolio",
        "CPC classification search",
        "Citation graph (1-3 hops)",
        "Patent family members",
        "Paste Google Patents URLs"
      ],
      "prefill": "searchPatents",
      "title": "Mode",
      "type": "string"
    },
    "patentType": {
      "default": "ANY",
      "description": "Utility-style patents or design patents.",
      "editor": "select",
      "enum": [
        "ANY",
        "PATENT",
        "DESIGN"
      ],
      "enumTitles": [
        "Any type",
        "Patent",
        "Design"
      ],
      "prefill": "ANY",
      "title": "Patent type",
      "type": "string"
    },
    "publicationNumbers": {
      "default": [],
      "description": "Publication numbers such as US11704715B2, EP3789012A1, WO2020012345A1. Used by byPatent, byCitation and byFamily.",
      "editor": "stringList",
      "prefill": [],
      "title": "Publication numbers",
      "type": "array"
    },
    "searchQueries": {
      "default": [
        "quantum computing"
      ],
      "description": "One or more keyword queries. Google Patents syntax works: quoted phrases, OR, minus, TI=(title words), CL=(claim words), CPC=H04L9/06.",
      "editor": "stringList",
      "prefill": [
        "quantum computing"
      ],
      "title": "Search queries",
      "type": "array"
    },
    "sortBy": {
      "default": "relevance",
      "description": "Google's relevance, newest first, or oldest first.",
      "editor": "select",
      "enum": [
        "relevance",
        "new",
        "old"
      ],
      "enumTitles": [
        "Relevance",
        "Newest first",
        "Oldest first"
      ],
      "prefill": "relevance",
      "title": "Sort order",
      "type": "string"
    },
    "status": {
      "default": "ANY",
      "description": "Any status, granted patents only, or published applications only.",
      "editor": "select",
      "enum": [
        "ANY",
        "GRANT",
        "APPLICATION"
      ],
      "enumTitles": [
        "Any",
        "Granted only",
        "Applications only"
      ],
      "prefill": "ANY",
      "title": "Grant status",
      "type": "string"
    },
    "urls": {
      "default": [],
      "description": "Patent pages (/patent/US.../en) or search pages (/?q=...&assignee=...&country=...). All search filters in the URL are honoured.",
      "editor": "stringList",
      "prefill": [],
      "title": "Google Patents URLs",
      "type": "array"
    }
  },
  "required": [
    "mode"
  ],
  "schemaVersion": 1,
  "title": "Google Patents Scraper Input",
  "type": "object"
}