| { |
| "kind": "discovery#restDescription", |
| "description": "View Ad Experience Report data, and get a list of sites that have a significant number of annoying ads.", |
| "servicePath": "", |
| "basePath": "", |
| "documentationLink": "https://developers.google.com/ad-experience-report/", |
| "revision": "20171002", |
| "id": "adexperiencereport:v1", |
| "discoveryVersion": "v1", |
| "version_module": true, |
| "schemas": { |
| "ViolatingSitesResponse": { |
| "description": "Response message for ListViolatingSites.", |
| "type": "object", |
| "properties": { |
| "violatingSites": { |
| "description": "A list of summaries of violating sites.", |
| "items": { |
| "$ref": "SiteSummaryResponse" |
| }, |
| "type": "array" |
| } |
| }, |
| "id": "ViolatingSitesResponse" |
| }, |
| "SiteSummaryResponse": { |
| "description": "Response message for GetSiteSummary.", |
| "type": "object", |
| "properties": { |
| "desktopSummary": { |
| "description": "Summary for the desktop review of the site.", |
| "$ref": "PlatformSummary" |
| }, |
| "mobileSummary": { |
| "$ref": "PlatformSummary", |
| "description": "Summary for the mobile review of the site." |
| }, |
| "reviewedSite": { |
| "description": "The name of the site reviewed.", |
| "type": "string" |
| } |
| }, |
| "id": "SiteSummaryResponse" |
| }, |
| "PlatformSummary": { |
| "description": "Summary of the ad experience rating of a site for a specific platform.", |
| "type": "object", |
| "properties": { |
| "betterAdsStatus": { |
| "enumDescriptions": [ |
| "Not reviewed.", |
| "Passing.", |
| "Warning.", |
| "Failing." |
| ], |
| "enum": [ |
| "UNKNOWN", |
| "PASSING", |
| "WARNING", |
| "FAILING" |
| ], |
| "description": "The status of the site reviewed for the Better Ads Standards.", |
| "type": "string" |
| }, |
| "enforcementTime": { |
| "format": "google-datetime", |
| "description": "The date on which ad filtering begins.", |
| "type": "string" |
| }, |
| "region": { |
| "description": "The assigned regions for the site and platform.", |
| "items": { |
| "enum": [ |
| "REGION_UNKNOWN", |
| "REGION_A", |
| "REGION_B" |
| ], |
| "type": "string" |
| }, |
| "type": "array", |
| "enumDescriptions": [ |
| "Ad standard not yet defined for your region.", |
| "Region A.", |
| "Region B." |
| ] |
| }, |
| "filterStatus": { |
| "enum": [ |
| "UNKNOWN", |
| "ON", |
| "OFF", |
| "PAUSED", |
| "PENDING" |
| ], |
| "description": "The ad filtering status of the site.", |
| "type": "string", |
| "enumDescriptions": [ |
| "N/A.", |
| "Ad filtering is on.", |
| "Ad filtering is off.", |
| "Ad filtering is paused.", |
| "Ad filtering is pending." |
| ] |
| }, |
| "underReview": { |
| "description": "Whether the site is currently under review.", |
| "type": "boolean" |
| }, |
| "reportUrl": { |
| "description": "A link that leads to a full ad experience report.", |
| "type": "string" |
| }, |
| "lastChangeTime": { |
| "format": "google-datetime", |
| "description": "The last time that the site changed status.", |
| "type": "string" |
| } |
| }, |
| "id": "PlatformSummary" |
| } |
| }, |
| "icons": { |
| "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| }, |
| "protocol": "rest", |
| "canonicalName": "Ad Experience Report", |
| "auth": { |
| "oauth2": { |
| "scopes": { |
| "https://www.googleapis.com/auth/xapi.zoo": { |
| "description": "Test scope for access to the Zoo service" |
| } |
| } |
| } |
| }, |
| "rootUrl": "https://adexperiencereport.googleapis.com/", |
| "ownerDomain": "google.com", |
| "name": "adexperiencereport", |
| "batchPath": "batch", |
| "title": "Google Ad Experience Report API", |
| "ownerName": "Google", |
| "resources": { |
| "sites": { |
| "methods": { |
| "get": { |
| "response": { |
| "$ref": "SiteSummaryResponse" |
| }, |
| "parameterOrder": [ |
| "name" |
| ], |
| "httpMethod": "GET", |
| "parameters": { |
| "name": { |
| "pattern": "^sites/[^/]+$", |
| "location": "path", |
| "description": "The required site name. It should be the site property whose ad experiences\nmay have been reviewed, and it should be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field returned by the\nAPI will lead to the verification page, prompting the user to go through\nthat process before they can gain access to the Ad Experience Report.", |
| "type": "string", |
| "required": true |
| } |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/xapi.zoo" |
| ], |
| "flatPath": "v1/sites/{sitesId}", |
| "id": "adexperiencereport.sites.get", |
| "path": "v1/{+name}", |
| "description": "Gets a summary of the ad experience rating of a site." |
| } |
| } |
| }, |
| "violatingSites": { |
| "methods": { |
| "list": { |
| "path": "v1/violatingSites", |
| "id": "adexperiencereport.violatingSites.list", |
| "description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\".", |
| "httpMethod": "GET", |
| "response": { |
| "$ref": "ViolatingSitesResponse" |
| }, |
| "parameterOrder": [], |
| "parameters": {}, |
| "scopes": [ |
| "https://www.googleapis.com/auth/xapi.zoo" |
| ], |
| "flatPath": "v1/violatingSites" |
| } |
| } |
| } |
| }, |
| "parameters": { |
| "fields": { |
| "location": "query", |
| "description": "Selector specifying which fields to include in a partial response.", |
| "type": "string" |
| }, |
| "uploadType": { |
| "location": "query", |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
| "type": "string" |
| }, |
| "$.xgafv": { |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ], |
| "location": "query", |
| "enum": [ |
| "1", |
| "2" |
| ], |
| "description": "V1 error format.", |
| "type": "string" |
| }, |
| "callback": { |
| "description": "JSONP", |
| "type": "string", |
| "location": "query" |
| }, |
| "alt": { |
| "description": "Data format for response.", |
| "default": "json", |
| "enum": [ |
| "json", |
| "media", |
| "proto" |
| ], |
| "type": "string", |
| "enumDescriptions": [ |
| "Responses with Content-Type of application/json", |
| "Media download with context-dependent Content-Type", |
| "Responses with Content-Type of application/x-protobuf" |
| ], |
| "location": "query" |
| }, |
| "access_token": { |
| "location": "query", |
| "description": "OAuth access token.", |
| "type": "string" |
| }, |
| "key": { |
| "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.", |
| "type": "string", |
| "location": "query" |
| }, |
| "quotaUser": { |
| "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.", |
| "type": "string", |
| "location": "query" |
| }, |
| "pp": { |
| "description": "Pretty-print response.", |
| "default": "true", |
| "type": "boolean", |
| "location": "query" |
| }, |
| "bearer_token": { |
| "description": "OAuth bearer token.", |
| "type": "string", |
| "location": "query" |
| }, |
| "oauth_token": { |
| "location": "query", |
| "description": "OAuth 2.0 token for the current user.", |
| "type": "string" |
| }, |
| "upload_protocol": { |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
| "type": "string", |
| "location": "query" |
| }, |
| "prettyPrint": { |
| "description": "Returns response with indentations and line breaks.", |
| "default": "true", |
| "type": "boolean", |
| "location": "query" |
| } |
| }, |
| "version": "v1", |
| "baseUrl": "https://adexperiencereport.googleapis.com/" |
| } |
