OLD | NEW |
1 { | 1 { |
2 "basePath": "", | 2 "basePath": "", |
3 "baseUrl": "https://acceleratedmobilepageurl.googleapis.com/", | 3 "baseUrl": "https://acceleratedmobilepageurl.googleapis.com/", |
4 "batchPath": "batch", | 4 "batchPath": "batch", |
5 "description": "This API contains a single method, batchGet. Call this metho
d to retrieve the AMP URL (and equivalent AMP Cache URL) for given public URL(s)
.\n", | 5 "description": "This API contains a single method, batchGet. Call this metho
d to retrieve the AMP URL (and equivalent AMP Cache URL) for given public URL(s)
.\n", |
6 "discoveryVersion": "v1", | 6 "discoveryVersion": "v1", |
7 "documentationLink": "https://developers.google.com/amp/cache/", | 7 "documentationLink": "https://developers.google.com/amp/cache/", |
8 "icons": { | 8 "icons": { |
9 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 9 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
10 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 10 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
11 }, | 11 }, |
12 "id": "acceleratedmobilepageurl:v1", | 12 "id": "acceleratedmobilepageurl:v1", |
13 "kind": "discovery#restDescription", | 13 "kind": "discovery#restDescription", |
14 "name": "acceleratedmobilepageurl", | 14 "name": "acceleratedmobilepageurl", |
15 "ownerDomain": "google.com", | 15 "ownerDomain": "google.com", |
16 "ownerName": "Google", | 16 "ownerName": "Google", |
17 "parameters": { | 17 "parameters": { |
18 "access_token": { | 18 "upload_protocol": { |
19 "description": "OAuth access token.", | 19 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
20 "location": "query", | 20 "location": "query", |
21 "type": "string" | 21 "type": "string" |
22 }, | 22 }, |
23 "prettyPrint": { | 23 "prettyPrint": { |
24 "default": "true", | 24 "default": "true", |
25 "description": "Returns response with indentations and line breaks."
, | 25 "description": "Returns response with indentations and line breaks."
, |
26 "location": "query", | 26 "location": "query", |
27 "type": "boolean" | 27 "type": "boolean" |
28 }, | 28 }, |
29 "key": { | |
30 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | |
31 "location": "query", | |
32 "type": "string" | |
33 }, | |
34 "quotaUser": { | |
35 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | |
36 "location": "query", | |
37 "type": "string" | |
38 }, | |
39 "pp": { | |
40 "default": "true", | |
41 "description": "Pretty-print response.", | |
42 "location": "query", | |
43 "type": "boolean" | |
44 }, | |
45 "fields": { | 29 "fields": { |
46 "description": "Selector specifying which fields to include in a par
tial response.", | 30 "description": "Selector specifying which fields to include in a par
tial response.", |
47 "location": "query", | 31 "location": "query", |
48 "type": "string" | 32 "type": "string" |
49 }, | 33 }, |
| 34 "uploadType": { |
| 35 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 36 "location": "query", |
| 37 "type": "string" |
| 38 }, |
| 39 "$.xgafv": { |
| 40 "description": "V1 error format.", |
| 41 "enum": [ |
| 42 "1", |
| 43 "2" |
| 44 ], |
| 45 "enumDescriptions": [ |
| 46 "v1 error format", |
| 47 "v2 error format" |
| 48 ], |
| 49 "location": "query", |
| 50 "type": "string" |
| 51 }, |
| 52 "callback": { |
| 53 "description": "JSONP", |
| 54 "location": "query", |
| 55 "type": "string" |
| 56 }, |
50 "alt": { | 57 "alt": { |
51 "default": "json", | 58 "default": "json", |
52 "description": "Data format for response.", | 59 "description": "Data format for response.", |
53 "enum": [ | 60 "enum": [ |
54 "json", | 61 "json", |
55 "media", | 62 "media", |
56 "proto" | 63 "proto" |
57 ], | 64 ], |
58 "enumDescriptions": [ | 65 "enumDescriptions": [ |
59 "Responses with Content-Type of application/json", | 66 "Responses with Content-Type of application/json", |
60 "Media download with context-dependent Content-Type", | 67 "Media download with context-dependent Content-Type", |
61 "Responses with Content-Type of application/x-protobuf" | 68 "Responses with Content-Type of application/x-protobuf" |
62 ], | 69 ], |
63 "location": "query", | 70 "location": "query", |
64 "type": "string" | 71 "type": "string" |
65 }, | 72 }, |
66 "$.xgafv": { | 73 "access_token": { |
67 "description": "V1 error format.", | 74 "description": "OAuth access token.", |
68 "enum": [ | |
69 "1", | |
70 "2" | |
71 ], | |
72 "enumDescriptions": [ | |
73 "v1 error format", | |
74 "v2 error format" | |
75 ], | |
76 "location": "query", | 75 "location": "query", |
77 "type": "string" | 76 "type": "string" |
78 }, | 77 }, |
79 "callback": { | 78 "key": { |
80 "description": "JSONP", | 79 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
81 "location": "query", | 80 "location": "query", |
82 "type": "string" | 81 "type": "string" |
83 }, | 82 }, |
84 "oauth_token": { | 83 "quotaUser": { |
85 "description": "OAuth 2.0 token for the current user.", | 84 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
86 "location": "query", | 85 "location": "query", |
87 "type": "string" | 86 "type": "string" |
88 }, | 87 }, |
89 "uploadType": { | 88 "pp": { |
90 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 89 "default": "true", |
| 90 "description": "Pretty-print response.", |
| 91 "location": "query", |
| 92 "type": "boolean" |
| 93 }, |
| 94 "oauth_token": { |
| 95 "description": "OAuth 2.0 token for the current user.", |
91 "location": "query", | 96 "location": "query", |
92 "type": "string" | 97 "type": "string" |
93 }, | 98 }, |
94 "bearer_token": { | 99 "bearer_token": { |
95 "description": "OAuth bearer token.", | 100 "description": "OAuth bearer token.", |
96 "location": "query", | 101 "location": "query", |
97 "type": "string" | 102 "type": "string" |
98 }, | |
99 "upload_protocol": { | |
100 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
101 "location": "query", | |
102 "type": "string" | |
103 } | 103 } |
104 }, | 104 }, |
105 "protocol": "rest", | 105 "protocol": "rest", |
106 "resources": { | 106 "resources": { |
107 "ampUrls": { | 107 "ampUrls": { |
108 "methods": { | 108 "methods": { |
109 "batchGet": { | 109 "batchGet": { |
110 "description": "Returns AMP URL(s) and equivalent\n[AMP Cach
e URL(s)](/amp/cache/overview#amp-cache-url-format).", | 110 "description": "Returns AMP URL(s) and equivalent\n[AMP Cach
e URL(s)](/amp/cache/overview#amp-cache-url-format).", |
111 "httpMethod": "POST", | 111 "httpMethod": "POST", |
112 "id": "acceleratedmobilepageurl.ampUrls.batchGet", | 112 "id": "acceleratedmobilepageurl.ampUrls.batchGet", |
113 "parameterOrder": [], | 113 "parameterOrder": [], |
114 "parameters": {}, | 114 "parameters": {}, |
115 "path": "v1/ampUrls:batchGet", | 115 "path": "v1/ampUrls:batchGet", |
116 "request": { | 116 "request": { |
117 "$ref": "BatchGetAmpUrlsRequest" | 117 "$ref": "BatchGetAmpUrlsRequest" |
118 }, | 118 }, |
119 "response": { | 119 "response": { |
120 "$ref": "BatchGetAmpUrlsResponse" | 120 "$ref": "BatchGetAmpUrlsResponse" |
121 } | 121 } |
122 } | 122 } |
123 } | 123 } |
124 } | 124 } |
125 }, | 125 }, |
126 "revision": "20170119", | 126 "revision": "20170126", |
127 "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/", | 127 "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/", |
128 "schemas": { | 128 "schemas": { |
| 129 "BatchGetAmpUrlsResponse": { |
| 130 "description": "Batch AMP URL response.", |
| 131 "id": "BatchGetAmpUrlsResponse", |
| 132 "properties": { |
| 133 "ampUrls": { |
| 134 "description": "For each URL in BatchAmpUrlsRequest, the URL
response. The response might\nnot be in the same order as URLs in the batch req
uest.\nIf BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated\nonly
once.", |
| 135 "items": { |
| 136 "$ref": "AmpUrl" |
| 137 }, |
| 138 "type": "array" |
| 139 }, |
| 140 "urlErrors": { |
| 141 "description": "The errors for requested URLs that have no A
MP URL.", |
| 142 "items": { |
| 143 "$ref": "AmpUrlError" |
| 144 }, |
| 145 "type": "array" |
| 146 } |
| 147 }, |
| 148 "type": "object" |
| 149 }, |
129 "AmpUrl": { | 150 "AmpUrl": { |
130 "description": "AMP URL response for a requested URL.", | 151 "description": "AMP URL response for a requested URL.", |
131 "id": "AmpUrl", | 152 "id": "AmpUrl", |
132 "properties": { | 153 "properties": { |
133 "ampUrl": { | 154 "cdnAmpUrl": { |
134 "description": "The AMP URL pointing to the publisher's web
server.", | 155 "description": "The [AMP Cache URL](/amp/cache/overview#amp-
cache-url-format) pointing to\nthe cached document in the Google AMP Cache.", |
135 "type": "string" | 156 "type": "string" |
136 }, | 157 }, |
137 "originalUrl": { | 158 "originalUrl": { |
138 "description": "The original non-AMP URL.", | 159 "description": "The original non-AMP URL.", |
139 "type": "string" | 160 "type": "string" |
140 }, | 161 }, |
141 "cdnAmpUrl": { | 162 "ampUrl": { |
142 "description": "The [AMP Cache URL](/amp/cache/overview#amp-
cache-url-format) pointing to\nthe cached document in the Google AMP Cache.", | 163 "description": "The AMP URL pointing to the publisher's web
server.", |
143 "type": "string" | 164 "type": "string" |
144 } | 165 } |
145 }, | 166 }, |
146 "type": "object" | 167 "type": "object" |
147 }, | 168 }, |
148 "AmpUrlError": { | 169 "AmpUrlError": { |
149 "description": "AMP URL Error resource for a requested URL that coul
dn't be found.", | 170 "description": "AMP URL Error resource for a requested URL that coul
dn't be found.", |
150 "id": "AmpUrlError", | 171 "id": "AmpUrlError", |
151 "properties": { | 172 "properties": { |
152 "originalUrl": { | 173 "errorMessage": { |
153 "description": "The original non-AMP URL.", | 174 "description": "An optional descriptive error message.", |
154 "type": "string" | 175 "type": "string" |
155 }, | 176 }, |
156 "errorCode": { | 177 "errorCode": { |
157 "description": "The error code of an API call.", | 178 "description": "The error code of an API call.", |
158 "enum": [ | 179 "enum": [ |
159 "ERROR_CODE_UNSPECIFIED", | 180 "ERROR_CODE_UNSPECIFIED", |
160 "INPUT_URL_NOT_FOUND", | 181 "INPUT_URL_NOT_FOUND", |
161 "NO_AMP_URL", | 182 "NO_AMP_URL", |
162 "APPLICATION_ERROR", | 183 "APPLICATION_ERROR", |
163 "URL_IS_VALID_AMP", | 184 "URL_IS_VALID_AMP", |
164 "URL_IS_INVALID_AMP" | 185 "URL_IS_INVALID_AMP" |
165 ], | 186 ], |
166 "enumDescriptions": [ | 187 "enumDescriptions": [ |
167 "Not specified error.", | 188 "Not specified error.", |
168 "Indicates the requested URL is not found in the index,
possibly because\nit's unable to be found, not able to be accessed by Googlebot,
or some\nother error.", | 189 "Indicates the requested URL is not found in the index,
possibly because\nit's unable to be found, not able to be accessed by Googlebot,
or some\nother error.", |
169 "Indicates no AMP URL has been found that corresponds to
the requested\nURL.", | 190 "Indicates no AMP URL has been found that corresponds to
the requested\nURL.", |
170 "Indicates some kind of application error occurred at th
e server.\nClient advised to retry.", | 191 "Indicates some kind of application error occurred at th
e server.\nClient advised to retry.", |
171 "DEPRECATED: Indicates the requested URL is a valid AMP
URL. This is a\nnon-error state, should not be relied upon as a sign of success
or\nfailure. It will be removed in future versions of the API.", | 192 "DEPRECATED: Indicates the requested URL is a valid AMP
URL. This is a\nnon-error state, should not be relied upon as a sign of success
or\nfailure. It will be removed in future versions of the API.", |
172 "Indicates that an AMP URL has been found that correspon
ds to the request\nURL, but it is not valid AMP HTML." | 193 "Indicates that an AMP URL has been found that correspon
ds to the request\nURL, but it is not valid AMP HTML." |
173 ], | 194 ], |
174 "type": "string" | 195 "type": "string" |
175 }, | 196 }, |
176 "errorMessage": { | 197 "originalUrl": { |
177 "description": "An optional descriptive error message.", | 198 "description": "The original non-AMP URL.", |
178 "type": "string" | 199 "type": "string" |
179 } | 200 } |
180 }, | 201 }, |
181 "type": "object" | 202 "type": "object" |
182 }, | 203 }, |
183 "BatchGetAmpUrlsRequest": { | 204 "BatchGetAmpUrlsRequest": { |
184 "description": "AMP URL request for a batch of URLs.", | 205 "description": "AMP URL request for a batch of URLs.", |
185 "id": "BatchGetAmpUrlsRequest", | 206 "id": "BatchGetAmpUrlsRequest", |
186 "properties": { | 207 "properties": { |
| 208 "urls": { |
| 209 "description": "List of URLs to look up for the paired AMP U
RLs.\nThe URLs are case-sensitive. Up to 50 URLs per lookup\n(see [Usage Limits]
(/amp/cache/reference/limits)).", |
| 210 "items": { |
| 211 "type": "string" |
| 212 }, |
| 213 "type": "array" |
| 214 }, |
187 "lookupStrategy": { | 215 "lookupStrategy": { |
188 "description": "The lookup_strategy being requested.", | 216 "description": "The lookup_strategy being requested.", |
189 "enum": [ | 217 "enum": [ |
190 "FETCH_LIVE_DOC", | 218 "FETCH_LIVE_DOC", |
191 "IN_INDEX_DOC" | 219 "IN_INDEX_DOC" |
192 ], | 220 ], |
193 "enumDescriptions": [ | 221 "enumDescriptions": [ |
194 "FETCH_LIVE_DOC strategy involves live document fetch of
URLs not found in\nthe index. Any request URL not found in the index is crawled
in realtime\nto validate if there is a corresponding AMP URL. This strategy has
higher\ncoverage but with extra latency introduced by realtime crawling. This i
s\nthe default strategy. Applications using this strategy should set higher\nHTT
P timeouts of the API calls.", | 222 "FETCH_LIVE_DOC strategy involves live document fetch of
URLs not found in\nthe index. Any request URL not found in the index is crawled
in realtime\nto validate if there is a corresponding AMP URL. This strategy has
higher\ncoverage but with extra latency introduced by realtime crawling. This i
s\nthe default strategy. Applications using this strategy should set higher\nHTT
P timeouts of the API calls.", |
195 "IN_INDEX_DOC strategy skips fetching live documents of
URL(s) not found\nin index. For applications which need low latency use of IN_IN
DEX_DOC\nstrategy is recommended." | 223 "IN_INDEX_DOC strategy skips fetching live documents of
URL(s) not found\nin index. For applications which need low latency use of IN_IN
DEX_DOC\nstrategy is recommended." |
196 ], | 224 ], |
197 "type": "string" | 225 "type": "string" |
198 }, | |
199 "urls": { | |
200 "description": "List of URLs to look up for the paired AMP U
RLs.\nThe URLs are case-sensitive. Up to 50 URLs per lookup\n(see [Usage Limits]
(/amp/cache/reference/limits)).", | |
201 "items": { | |
202 "type": "string" | |
203 }, | |
204 "type": "array" | |
205 } | 226 } |
206 }, | 227 }, |
207 "type": "object" | 228 "type": "object" |
208 }, | |
209 "BatchGetAmpUrlsResponse": { | |
210 "description": "Batch AMP URL response.", | |
211 "id": "BatchGetAmpUrlsResponse", | |
212 "properties": { | |
213 "urlErrors": { | |
214 "description": "The errors for requested URLs that have no A
MP URL.", | |
215 "items": { | |
216 "$ref": "AmpUrlError" | |
217 }, | |
218 "type": "array" | |
219 }, | |
220 "ampUrls": { | |
221 "description": "For each URL in BatchAmpUrlsRequest, the URL
response. The response might\nnot be in the same order as URLs in the batch req
uest.\nIf BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated\nonly
once.", | |
222 "items": { | |
223 "$ref": "AmpUrl" | |
224 }, | |
225 "type": "array" | |
226 } | |
227 }, | |
228 "type": "object" | |
229 } | 229 } |
230 }, | 230 }, |
231 "servicePath": "", | 231 "servicePath": "", |
232 "title": "Accelerated Mobile Pages (AMP) URL API", | 232 "title": "Accelerated Mobile Pages (AMP) URL API", |
233 "version": "v1" | 233 "version": "v1" |
234 } | 234 } |
OLD | NEW |