Method: accounts.locations.list

지정된 계정의 위치를 나열합니다.

HTTP 요청

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
parent

string

위치를 가져올 계정의 이름입니다. Account의 값이 AccountType 개인인 경우 계정에서 직접 소유한 위치만 반환되며, 그렇지 않은 경우 계정에서 액세스 가능한 모든 위치를 직접 또는 간접적으로 반환합니다.

쿼리 매개변수

매개변수
pageSize

integer

페이지당 가져올 위치 수입니다. 기본값은 100, 최소는 1, 최대 페이지 크기는 100입니다.
pageToken

string

지정하면 위치의 다음 page를 가져옵니다. 요청된 페이지 크기에 들어갈 수 있는 위치보다 위치가 더 많은 경우 locations.list에 대한 이전 호출에서 페이지 토큰이 반환됩니다.
filter

string

반환할 위치를 제한하는 필터입니다. 응답에는 필터와 일치하는 항목만 포함됩니다. filter가 비어 있으면 제약 조건이 적용되고 요청된 계정의 모든 위치 (페이지로 매김)가 검색됩니다.

유효한 필드 및 사용 예에 대한 자세한 내용은 위치 데이터 사용 가이드를 참고하세요.
languageCode
(deprecated)

string

디스플레이 위치 속성을 가져올 BCP 47 언어 코드입니다. 이 언어를 사용할 수 없는 경우 해당 국가의 언어로 제공됩니다. 둘 다 사용할 수 없는 경우 영어로 제공됩니다.

지원 중단되었습니다. 2020년 8월 15일 이후에는 이 입력란이 더 이상 적용되지 않습니다. 대신 해당 위치의 언어가 항상 사용됩니다.
orderBy

string

요청의 정렬 순서입니다. 여러 필드는 SQL 구문에 따라 쉼표로 구분해야 합니다. 기본 정렬 순서는 오름차순입니다. 내림차순으로 지정하려면 서픽스 ' desc" 를 추가해야 합니다. orderBy의 유효한 필드는 locationName 및 storeCode입니다. 예: 'locationName, storeCode desc' 또는 'locationName' 또는 'storeCode desc'

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

Locations.ListLocations의 응답 메시지입니다.

JSON 표현 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
필드
locations[]

object (Location)

위치
nextPageToken

string

위치 수가 요청된 페이지 크기를 초과하면 이 필드는 locations.list에 대한 후속 호출에서 다음 위치 페이지를 가져오는 토큰으로 채워집니다. 더 이상 위치가 없으면 이 필드는 응답에 표시되지 않습니다.
totalSize

integer

페이지로 나누기와 관계없이 목록에 있는 대략적인 위치 수입니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

자세한 내용은 OAuth 2.0 개요를 참고하세요.