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