Google Search Console API . urlTestingTools . mobileFriendlyTest

Instance Methods

close()

Close httplib2 connections.

run(body=None, x__xgafv=None)

Runs Mobile-Friendly Test for a given URL.

Method Details

close()
Close httplib2 connections.
run(body=None, x__xgafv=None)
Runs Mobile-Friendly Test for a given URL.

Args:
  body: object, The request body.
    The object takes the form of:

{ # Mobile-friendly test request.
  "requestScreenshot": True or False, # Whether or not screenshot is requested. Default is false.
  "url": "A String", # URL for inspection.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Mobile-friendly test response, including mobile-friendly issues and resource issues.
  "mobileFriendliness": "A String", # Test verdict, whether the page is mobile friendly or not.
  "mobileFriendlyIssues": [ # List of mobile-usability issues.
    { # Mobile-friendly issue.
      "rule": "A String", # Rule violated.
    },
  ],
  "resourceIssues": [ # Information about embedded resources issues.
    { # Information about a resource with issue.
      "blockedResource": { # Blocked resource. # Describes a blocked resource issue.
        "url": "A String", # URL of the blocked resource.
      },
    },
  ],
  "screenshot": { # Describe image data. # Screenshot of the requested URL.
    "data": "A String", # Image data in format determined by the mime type. Currently, the format will always be "image/png", but this might change in the future.
    "mimeType": "A String", # The mime-type of the image data.
  },
  "testStatus": { # Final state of the test, including error details if necessary. # Final state of the test, can be either complete or an error.
    "details": "A String", # Error details if applicable.
    "status": "A String", # Status of the test.
  },
}