Representatives: representativeInfoByAddress

1 つの住所の行政区域と代表的な情報を検索します。 実習をご覧ください。

リクエスト

HTTP リクエスト

GET https://www.googleapis.com/civicinfo/v2/representatives

パラメータ

パラメータ名 値 説明
省略可能なクエリ パラメータ
address string 検索する住所。URL で ocdId フィールドが指定されていない場合にのみ指定できます。
includeOffices boolean オフィスや職員に関する情報を返すかどうか。false の場合、最上位の学区情報のみが返されます。 （デフォルト: true）。
levels string フィルタするオフィスレベルのリスト。これらのレベルの少なくとも 1 つを提供するオフィスのみが返されます。一致するオフィスがない部門は返されません。

有効な値は次のとおりです。
  • "administrativeArea1"
  • "administrativeArea2"
  • "country"
  • "international"
  • "locality"
  • "regional"
  • "special"
  • "subLocality1"
  • "subLocality2"
roles string フィルタするオフィスのロールのリスト。これらの役割のいずれかを満たすオフィスのみが返されます。一致するオフィスを含まない部門は返されません。

有効な値は次のとおりです。
  • "deputyHeadOfGovernment"
  • "executiveCouncil"
  • "governmentOfficer"
  • "headOfGovernment"
  • "headOfState"
  • "highestCourtJudge"
  • "judge"
  • "legislatorLowerBody"
  • "legislatorUpperBody"
  • "schoolBoard"
  • "specialPurposeOfficer"

リクエスト本文

このメソッドをリクエストの本文に含めないでください。

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "kind": "civicinfo#representativeInfoResponse",
  "normalizedInput": {
    "locationName": string,
    "line1": string,
    "line2": string,
    "line3": string,
    "city": string,
    "state": string,
    "zip": string
  },
  "divisions": {
    (key): {
      "name": string,
      "alsoKnownAs": [
        string
      ],
      "officeIndices": [
        unsigned integer
      ]
    }
  },
  "offices": [
    {
      "name": string,
      "divisionId": string,
      "levels": [
        string
      ],
      "roles": [
        string
      ],
      "sources": [
        {
          "name": string,
          "official": boolean
        }
      ],
      "officialIndices": [
        unsigned integer
      ]
    }
  ],
  "officials": [
    {
      "name": string,
      "address": [
        {
          "locationName": string,
          "line1": string,
          "line2": string,
          "line3": string,
          "city": string,
          "state": string,
          "zip": string
        }
      ],
      "party": string,
      "phones": [
        string
      ],
      "urls": [
        string
      ],
      "photoUrl": string,
      "emails": [
        string
      ],
      "channels": [
        {
          "type": string,
          "id": string
        }
      ]
    }
  ]
}
プロパティ名 値 説明 メモ
kind string リソースの種類を指定します。値: 固定文字列 "civicinfo#representativeInfoResponse"。
normalizedInput nested object リクエストされた住所の正規化バージョン
normalizedInput.locationName string 場所の名前。
normalizedInput.line1 string この住所の番地。
normalizedInput.line2 string 必要に応じて、2 行目に住所を入力します。
normalizedInput.line3 string 必要に応じて、住所の 3 行目。
normalizedInput.city string 住所の市区町村。
normalizedInput.state string 住所の 2 文字の州コード（米国）。
normalizedInput.zip string 住所の米国の郵便番号。
divisions object リクエストされた住所を含む行政区域。詳細については、担当者向けのリソースのドキュメントをご覧ください。
offices[] list 上記の部門によって参照される公選職。リクエストで includeOffices が true であった場合にのみ存在します。詳細については、担当者向けのリソースのドキュメントをご覧ください。
officials[] list 上記のオフィスを保有する職員。リクエストで includeOffices が true であった場合にのみ存在します。詳細については、担当者向けのリソースのドキュメントをご覧ください。

試してみよう: