1{
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/indexing": {
6 "description": "Submit data to Google for indexing"
7 }
8 }
9 }
10 },
11 "basePath": "",
12 "baseUrl": "https://indexing.googleapis.com/",
13 "batchPath": "batch",
14 "canonicalName": "Indexing",
15 "description": "Notifies Google Web Search when your web pages change.",
16 "discoveryVersion": "v1",
17 "documentationLink": "https://developers.google.com/search/apis/indexing-api/",
18 "fullyEncodeReservedExpansion": true,
19 "icons": {
20 "x16": "http://www.google.com/images/icons/product/search-16.gif",
21 "x32": "http://www.google.com/images/icons/product/search-32.gif"
22 },
23 "id": "indexing:v3",
24 "kind": "discovery#restDescription",
25 "mtlsRootUrl": "https://indexing.mtls.googleapis.com/",
26 "name": "indexing",
27 "ownerDomain": "google.com",
28 "ownerName": "Google",
29 "parameters": {
30 "$.xgafv": {
31 "description": "V1 error format.",
32 "enum": [
33 "1",
34 "2"
35 ],
36 "enumDescriptions": [
37 "v1 error format",
38 "v2 error format"
39 ],
40 "location": "query",
41 "type": "string"
42 },
43 "access_token": {
44 "description": "OAuth access token.",
45 "location": "query",
46 "type": "string"
47 },
48 "alt": {
49 "default": "json",
50 "description": "Data format for response.",
51 "enum": [
52 "json",
53 "media",
54 "proto"
55 ],
56 "enumDescriptions": [
57 "Responses with Content-Type of application/json",
58 "Media download with context-dependent Content-Type",
59 "Responses with Content-Type of application/x-protobuf"
60 ],
61 "location": "query",
62 "type": "string"
63 },
64 "callback": {
65 "description": "JSONP",
66 "location": "query",
67 "type": "string"
68 },
69 "fields": {
70 "description": "Selector specifying which fields to include in a partial response.",
71 "location": "query",
72 "type": "string"
73 },
74 "key": {
75 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
76 "location": "query",
77 "type": "string"
78 },
79 "oauth_token": {
80 "description": "OAuth 2.0 token for the current user.",
81 "location": "query",
82 "type": "string"
83 },
84 "prettyPrint": {
85 "default": "true",
86 "description": "Returns response with indentations and line breaks.",
87 "location": "query",
88 "type": "boolean"
89 },
90 "quotaUser": {
91 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
92 "location": "query",
93 "type": "string"
94 },
95 "uploadType": {
96 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
97 "location": "query",
98 "type": "string"
99 },
100 "upload_protocol": {
101 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
102 "location": "query",
103 "type": "string"
104 }
105 },
106 "protocol": "rest",
107 "resources": {
108 "urlNotifications": {
109 "methods": {
110 "getMetadata": {
111 "description": "Gets metadata about a Web Document. This method can _only_ be used to query URLs that were previously seen in successful Indexing API notifications. Includes the latest `UrlNotification` received via this API.",
112 "flatPath": "v3/urlNotifications/metadata",
113 "httpMethod": "GET",
114 "id": "indexing.urlNotifications.getMetadata",
115 "parameterOrder": [],
116 "parameters": {
117 "url": {
118 "description": "URL that is being queried.",
119 "location": "query",
120 "type": "string"
121 }
122 },
123 "path": "v3/urlNotifications/metadata",
124 "response": {
125 "$ref": "UrlNotificationMetadata"
126 },
127 "scopes": [
128 "https://www.googleapis.com/auth/indexing"
129 ]
130 },
131 "publish": {
132 "description": "Notifies that a URL has been updated or deleted.",
133 "flatPath": "v3/urlNotifications:publish",
134 "httpMethod": "POST",
135 "id": "indexing.urlNotifications.publish",
136 "parameterOrder": [],
137 "parameters": {},
138 "path": "v3/urlNotifications:publish",
139 "request": {
140 "$ref": "UrlNotification"
141 },
142 "response": {
143 "$ref": "PublishUrlNotificationResponse"
144 },
145 "scopes": [
146 "https://www.googleapis.com/auth/indexing"
147 ]
148 }
149 }
150 }
151 },
152 "revision": "20230927",
153 "rootUrl": "https://indexing.googleapis.com/",
154 "schemas": {
155 "PublishUrlNotificationResponse": {
156 "description": "Output for PublishUrlNotification",
157 "id": "PublishUrlNotificationResponse",
158 "properties": {
159 "urlNotificationMetadata": {
160 "$ref": "UrlNotificationMetadata",
161 "description": "Description of the notification events received for this URL."
162 }
163 },
164 "type": "object"
165 },
166 "UrlNotification": {
167 "description": "`UrlNotification` is the resource used in all Indexing API calls. It describes one event in the life cycle of a Web Document.",
168 "id": "UrlNotification",
169 "properties": {
170 "notifyTime": {
171 "description": "Creation timestamp for this notification. Users should _not_ specify it, the field is ignored at the request time.",
172 "format": "google-datetime",
173 "type": "string"
174 },
175 "type": {
176 "description": "The URL life cycle event that Google is being notified about.",
177 "enum": [
178 "URL_NOTIFICATION_TYPE_UNSPECIFIED",
179 "URL_UPDATED",
180 "URL_DELETED"
181 ],
182 "enumDescriptions": [
183 "Unspecified.",
184 "The given URL (Web document) has been updated.",
185 "The given URL (Web document) has been deleted."
186 ],
187 "type": "string"
188 },
189 "url": {
190 "description": "The object of this notification. The URL must be owned by the publisher of this notification and, in case of `URL_UPDATED` notifications, it _must_ be crawlable by Google.",
191 "type": "string"
192 }
193 },
194 "type": "object"
195 },
196 "UrlNotificationMetadata": {
197 "description": "Summary of the most recent Indexing API notifications successfully received, for a given URL.",
198 "id": "UrlNotificationMetadata",
199 "properties": {
200 "latestRemove": {
201 "$ref": "UrlNotification",
202 "description": "Latest notification received with type `URL_REMOVED`."
203 },
204 "latestUpdate": {
205 "$ref": "UrlNotification",
206 "description": "Latest notification received with type `URL_UPDATED`."
207 },
208 "url": {
209 "description": "URL to which this metadata refers.",
210 "type": "string"
211 }
212 },
213 "type": "object"
214 }
215 },
216 "servicePath": "",
217 "title": "Web Search Indexing API",
218 "version": "v3",
219 "version_module": true
220}View as plain text