1{
2  "basePath": "",
3  "baseUrl": "https://adexperiencereport.googleapis.com/",
4  "batchPath": "batch",
5  "canonicalName": "Ad Experience Report",
6  "description": "Views Ad Experience Report data, and gets a list of sites that have a significant number of annoying ads.",
7  "discoveryVersion": "v1",
8  "documentationLink": "https://developers.google.com/ad-experience-report/",
9  "icons": {
10    "x16": "http://www.google.com/images/icons/product/search-16.gif",
11    "x32": "http://www.google.com/images/icons/product/search-32.gif"
12  },
13  "id": "adexperiencereport:v1",
14  "kind": "discovery#restDescription",
15  "mtlsRootUrl": "https://adexperiencereport.mtls.googleapis.com/",
16  "name": "adexperiencereport",
17  "ownerDomain": "google.com",
18  "ownerName": "Google",
19  "parameters": {
20    "$.xgafv": {
21      "description": "V1 error format.",
22      "enum": [
23        "1",
24        "2"
25      ],
26      "enumDescriptions": [
27        "v1 error format",
28        "v2 error format"
29      ],
30      "location": "query",
31      "type": "string"
32    },
33    "access_token": {
34      "description": "OAuth access token.",
35      "location": "query",
36      "type": "string"
37    },
38    "alt": {
39      "default": "json",
40      "description": "Data format for response.",
41      "enum": [
42        "json",
43        "media",
44        "proto"
45      ],
46      "enumDescriptions": [
47        "Responses with Content-Type of application/json",
48        "Media download with context-dependent Content-Type",
49        "Responses with Content-Type of application/x-protobuf"
50      ],
51      "location": "query",
52      "type": "string"
53    },
54    "callback": {
55      "description": "JSONP",
56      "location": "query",
57      "type": "string"
58    },
59    "fields": {
60      "description": "Selector specifying which fields to include in a partial response.",
61      "location": "query",
62      "type": "string"
63    },
64    "key": {
65      "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.",
66      "location": "query",
67      "type": "string"
68    },
69    "oauth_token": {
70      "description": "OAuth 2.0 token for the current user.",
71      "location": "query",
72      "type": "string"
73    },
74    "prettyPrint": {
75      "default": "true",
76      "description": "Returns response with indentations and line breaks.",
77      "location": "query",
78      "type": "boolean"
79    },
80    "quotaUser": {
81      "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.",
82      "location": "query",
83      "type": "string"
84    },
85    "uploadType": {
86      "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
87      "location": "query",
88      "type": "string"
89    },
90    "upload_protocol": {
91      "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
92      "location": "query",
93      "type": "string"
94    }
95  },
96  "protocol": "rest",
97  "resources": {
98    "sites": {
99      "methods": {
100        "get": {
101          "description": "Gets a site's Ad Experience Report summary.",
102          "flatPath": "v1/sites/{sitesId}",
103          "httpMethod": "GET",
104          "id": "adexperiencereport.sites.get",
105          "parameterOrder": [
106            "name"
107          ],
108          "parameters": {
109            "name": {
110              "description": "Required. The name of the site whose summary to get, e.g. `sites/http%3A%2F%2Fwww.google.com%2F`. Format: `sites/{site}`",
111              "location": "path",
112              "pattern": "^sites/[^/]+$",
113              "required": true,
114              "type": "string"
115            }
116          },
117          "path": "v1/{+name}",
118          "response": {
119            "$ref": "SiteSummaryResponse"
120          }
121        }
122      }
123    },
124    "violatingSites": {
125      "methods": {
126        "list": {
127          "description": "Lists sites that are failing in the Ad Experience Report on at least one platform.",
128          "flatPath": "v1/violatingSites",
129          "httpMethod": "GET",
130          "id": "adexperiencereport.violatingSites.list",
131          "parameterOrder": [],
132          "parameters": {},
133          "path": "v1/violatingSites",
134          "response": {
135            "$ref": "ViolatingSitesResponse"
136          }
137        }
138      }
139    }
140  },
141  "revision": "20211129",
142  "rootUrl": "https://adexperiencereport.googleapis.com/",
143  "schemas": {
144    "PlatformSummary": {
145      "description": "A site's Ad Experience Report summary on a single platform.",
146      "id": "PlatformSummary",
147      "properties": {
148        "betterAdsStatus": {
149          "description": "The site's Ad Experience Report status on this platform.",
150          "enum": [
151            "UNKNOWN",
152            "PASSING",
153            "WARNING",
154            "FAILING"
155          ],
156          "enumDescriptions": [
157            "Not reviewed.",
158            "Passing.",
159            "Warning. No longer a possible status.",
160            "Failing."
161          ],
162          "type": "string"
163        },
164        "enforcementTime": {
165          "description": "The time at which [enforcement](https://support.google.com/webtools/answer/7308033) against the site began or will begin on this platform. Not set when the filter_status is OFF.",
166          "format": "google-datetime",
167          "type": "string"
168        },
169        "filterStatus": {
170          "description": "The site's [enforcement status](https://support.google.com/webtools/answer/7308033) on this platform.",
171          "enum": [
172            "UNKNOWN",
173            "ON",
174            "OFF",
175            "PAUSED",
176            "PENDING"
177          ],
178          "enumDescriptions": [
179            "N/A.",
180            "Ad filtering is on.",
181            "Ad filtering is off.",
182            "Ad filtering is paused.",
183            "Ad filtering is pending."
184          ],
185          "type": "string"
186        },
187        "lastChangeTime": {
188          "description": "The time at which the site's status last changed on this platform.",
189          "format": "google-datetime",
190          "type": "string"
191        },
192        "region": {
193          "description": "The site's regions on this platform. No longer populated, because there is no longer any semantic difference between sites in different regions.",
194          "items": {
195            "enum": [
196              "REGION_UNKNOWN",
197              "REGION_A",
198              "REGION_B",
199              "REGION_C"
200            ],
201            "enumDescriptions": [
202              "Ad standard not yet defined for your region.",
203              "Region A.",
204              "Region B.",
205              "Region C."
206            ],
207            "type": "string"
208          },
209          "type": "array"
210        },
211        "reportUrl": {
212          "description": "A link to the full Ad Experience Report for the site on this platform.. Not set in ViolatingSitesResponse. Note that you must complete the [Search Console verification process](https://support.google.com/webmasters/answer/9008080) for the site before you can access the full report.",
213          "type": "string"
214        },
215        "underReview": {
216          "description": "Whether the site is currently under review on this platform.",
217          "type": "boolean"
218        }
219      },
220      "type": "object"
221    },
222    "SiteSummaryResponse": {
223      "description": "Response message for GetSiteSummary.",
224      "id": "SiteSummaryResponse",
225      "properties": {
226        "desktopSummary": {
227          "$ref": "PlatformSummary",
228          "description": "The site's Ad Experience Report summary on desktop."
229        },
230        "mobileSummary": {
231          "$ref": "PlatformSummary",
232          "description": "The site's Ad Experience Report summary on mobile."
233        },
234        "reviewedSite": {
235          "description": "The name of the reviewed site, e.g. `google.com`.",
236          "type": "string"
237        }
238      },
239      "type": "object"
240    },
241    "ViolatingSitesResponse": {
242      "description": "Response message for ListViolatingSites.",
243      "id": "ViolatingSitesResponse",
244      "properties": {
245        "violatingSites": {
246          "description": "The list of violating sites.",
247          "items": {
248            "$ref": "SiteSummaryResponse"
249          },
250          "type": "array"
251        }
252      },
253      "type": "object"
254    }
255  },
256  "servicePath": "",
257  "title": "Ad Experience Report API",
258  "version": "v1",
259  "version_module": true
260}