You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

219 lines
7.0 KiB

  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 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. "name": "indexing",
  26. "ownerDomain": "google.com",
  27. "ownerName": "Google",
  28. "parameters": {
  29. "$.xgafv": {
  30. "description": "V1 error format.",
  31. "enum": [
  32. "1",
  33. "2"
  34. ],
  35. "enumDescriptions": [
  36. "v1 error format",
  37. "v2 error format"
  38. ],
  39. "location": "query",
  40. "type": "string"
  41. },
  42. "access_token": {
  43. "description": "OAuth access token.",
  44. "location": "query",
  45. "type": "string"
  46. },
  47. "alt": {
  48. "default": "json",
  49. "description": "Data format for response.",
  50. "enum": [
  51. "json",
  52. "media",
  53. "proto"
  54. ],
  55. "enumDescriptions": [
  56. "Responses with Content-Type of application/json",
  57. "Media download with context-dependent Content-Type",
  58. "Responses with Content-Type of application/x-protobuf"
  59. ],
  60. "location": "query",
  61. "type": "string"
  62. },
  63. "callback": {
  64. "description": "JSONP",
  65. "location": "query",
  66. "type": "string"
  67. },
  68. "fields": {
  69. "description": "Selector specifying which fields to include in a partial response.",
  70. "location": "query",
  71. "type": "string"
  72. },
  73. "key": {
  74. "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.",
  75. "location": "query",
  76. "type": "string"
  77. },
  78. "oauth_token": {
  79. "description": "OAuth 2.0 token for the current user.",
  80. "location": "query",
  81. "type": "string"
  82. },
  83. "prettyPrint": {
  84. "default": "true",
  85. "description": "Returns response with indentations and line breaks.",
  86. "location": "query",
  87. "type": "boolean"
  88. },
  89. "quotaUser": {
  90. "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.",
  91. "location": "query",
  92. "type": "string"
  93. },
  94. "uploadType": {
  95. "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
  96. "location": "query",
  97. "type": "string"
  98. },
  99. "upload_protocol": {
  100. "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
  101. "location": "query",
  102. "type": "string"
  103. }
  104. },
  105. "protocol": "rest",
  106. "resources": {
  107. "urlNotifications": {
  108. "methods": {
  109. "getMetadata": {
  110. "description": "Gets metadata about a Web Document. This method can _only_ be used to query\nURLs that were previously seen in successful Indexing API notifications.\nIncludes the latest `UrlNotification` received via this API.",
  111. "flatPath": "v3/urlNotifications/metadata",
  112. "httpMethod": "GET",
  113. "id": "indexing.urlNotifications.getMetadata",
  114. "parameterOrder": [],
  115. "parameters": {
  116. "url": {
  117. "description": "URL that is being queried.",
  118. "location": "query",
  119. "type": "string"
  120. }
  121. },
  122. "path": "v3/urlNotifications/metadata",
  123. "response": {
  124. "$ref": "UrlNotificationMetadata"
  125. },
  126. "scopes": [
  127. "https://www.googleapis.com/auth/indexing"
  128. ]
  129. },
  130. "publish": {
  131. "description": "Notifies that a URL has been updated or deleted.",
  132. "flatPath": "v3/urlNotifications:publish",
  133. "httpMethod": "POST",
  134. "id": "indexing.urlNotifications.publish",
  135. "parameterOrder": [],
  136. "parameters": {},
  137. "path": "v3/urlNotifications:publish",
  138. "request": {
  139. "$ref": "UrlNotification"
  140. },
  141. "response": {
  142. "$ref": "PublishUrlNotificationResponse"
  143. },
  144. "scopes": [
  145. "https://www.googleapis.com/auth/indexing"
  146. ]
  147. }
  148. }
  149. }
  150. },
  151. "revision": "20181012",
  152. "rootUrl": "https://indexing.googleapis.com/",
  153. "schemas": {
  154. "PublishUrlNotificationResponse": {
  155. "description": "Output for PublishUrlNotification",
  156. "id": "PublishUrlNotificationResponse",
  157. "properties": {
  158. "urlNotificationMetadata": {
  159. "$ref": "UrlNotificationMetadata",
  160. "description": "Description of the notification events received for this URL."
  161. }
  162. },
  163. "type": "object"
  164. },
  165. "UrlNotification": {
  166. "description": "`UrlNotification` is the resource used in all Indexing API calls.\nIt describes one event in the life cycle of a Web Document.",
  167. "id": "UrlNotification",
  168. "properties": {
  169. "notifyTime": {
  170. "description": "Creation timestamp for this notification.\nUsers should _not_ specify it, the field is ignored at the request time.",
  171. "format": "google-datetime",
  172. "type": "string"
  173. },
  174. "type": {
  175. "description": "The URL life cycle event that Google is being notified about.",
  176. "enum": [
  177. "URL_NOTIFICATION_TYPE_UNSPECIFIED",
  178. "URL_UPDATED",
  179. "URL_DELETED"
  180. ],
  181. "enumDescriptions": [
  182. "Unspecified.",
  183. "The given URL (Web document) has been updated.",
  184. "The given URL (Web document) has been deleted."
  185. ],
  186. "type": "string"
  187. },
  188. "url": {
  189. "description": "The object of this notification. The URL must be owned by the publisher\nof this notification and, in case of `URL_UPDATED` notifications, it _must_\nbe crawlable by Google.",
  190. "type": "string"
  191. }
  192. },
  193. "type": "object"
  194. },
  195. "UrlNotificationMetadata": {
  196. "description": "Summary of the most recent Indexing API notifications successfully received,\nfor a given URL.",
  197. "id": "UrlNotificationMetadata",
  198. "properties": {
  199. "latestRemove": {
  200. "$ref": "UrlNotification",
  201. "description": "Latest notification received with type `URL_REMOVED`."
  202. },
  203. "latestUpdate": {
  204. "$ref": "UrlNotification",
  205. "description": "Latest notification received with type `URL_UPDATED`."
  206. },
  207. "url": {
  208. "description": "URL to which this metadata refers.",
  209. "type": "string"
  210. }
  211. },
  212. "type": "object"
  213. }
  214. },
  215. "servicePath": "",
  216. "title": "Indexing API",
  217. "version": "v3",
  218. "version_module": true
  219. }