Google Search Console · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Google Web Search Indexing URL Notifications API

3 actions 3 updates phrasing extends openapi/google-search-console-urlnotifications-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Google Search Console's API. It is a proposal applied on top of the contract, not a document Google Search Console publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v3/urlNotifications:publish'].post
$.paths['/v3/urlNotifications/metadata'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Google Web Search Indexing URL Notifications API
  version: 1.0.0
extends: openapi/google-search-console-urlnotifications-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v3/urlNotifications:publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Notify Google a URL was updated or deleted
      effect: write
      questions:
      - How do I tell Google's Indexing API that a page on my site just changed?
      - Can I notify Google that a URL has been removed so it drops it?
      - Should I set the notification timestamp myself when publishing a URL update?
      instructions:
      - text: Notify Google that {url} was updated.
        slots:
          url: requestBody.url
      - text: Send a {type} notification for {url} to the Indexing API.
        slots:
          type: requestBody.type
          url: requestBody.url
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/urlNotifications/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Indexing API notification metadata for a URL
      effect: read
      questions:
      - What was the latest Indexing API notification Google received for my page?
      - Can I check notification history for a URL I never sent through the Indexing API?
      instructions:
      - text: Get the Indexing API notification metadata for {url}.
        slots:
          url: query.url
      - text: Show the most recent URL notification recorded for {url}.
        slots:
          url: query.url
      method: generated
      generated: '2026-10-01'