(PureBasic) Google Search Console API - List

Lists the user's Search Console sites.

For more information, see https://developers.google.com/webmaster-tools/search-console-api-original/v3/sites/list

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    ; This example requires the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    ; This example uses a previously obtained access token having permission for the 
    ; Google Search Console scope.

    ; In this example, Get a Google Search Console OAuth2 Access Token, the access
    ; token was saved to a JSON file.  This example fetches the access token from the file..
    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/googleSearchConsole.json")
    If CkJsonObject::ckHasMember(jsonToken,"access_token") = 0
        Debug "No access token found."
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttp::setCkAuthToken(http, CkJsonObject::ckStringOf(jsonToken,"access_token"))

    responseStr.s = CkHttp::ckQuickGetStr(http,"https://www.googleapis.com/webmasters/v3/sites")
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkJsonObject::ckDispose(jsonToken)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    statusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code: " + Str(statusCode)

    ; Sample response:

    ; {
    ;  "siteEntry": [
    ;   {
    ;    "siteUrl": "https://www.example.com/",
    ;    "permissionLevel": "siteUnverifiedUser"
    ;   },
    ;   {
    ;    "siteUrl": "http://www.chilkatsoft.com/",
    ;    "permissionLevel": "siteOwner"
    ;   }
    ;  ]
    ; }

    Debug responseStr

    ; Use this online tool to generate parsing code from sample JSON: 
    ; Generate Parsing Code from JSON

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkJsonObject::ckLoad(json,responseStr)

    siteUrl.s
    permissionLevel.s

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(json,"siteEntry")
    While i < count_i
        CkJsonObject::setCkI(json, i)
        siteUrl = CkJsonObject::ckStringOf(json,"siteEntry[i].siteUrl")
        Debug "siteUrl: " + siteUrl
        permissionLevel = CkJsonObject::ckStringOf(json,"siteEntry[i].permissionLevel")
        Debug "permissionLevel: " + permissionLevel
        i = i + 1
    Wend


    CkJsonObject::ckDispose(jsonToken)
    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure