지정된 계정의 위치를 나열합니다.
HTTP 요청
GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations
URL은 gRPC 트랜스코딩 구문을 사용합니다.
경로 매개변수
매개변수 | |
---|---|
parent |
필수 항목입니다. 위치를 가져올 계정의 이름입니다. 상위 [계정] [google.mybusiness.accountmanagement.v1.Account] 가 [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL인 경우, 계정에서 직접 소유한 위치만 반환되며, 그렇지 않은 경우 직간접적으로 계정에서 액세스할 수 있는 모든 위치가 반환됩니다. |
쿼리 매개변수
매개변수 | |
---|---|
pageSize |
선택사항입니다. 페이지당 가져올 위치 수입니다. 설정하지 않으면 기본값은 10입니다. 최소 1, 최대 페이지 크기는 100입니다. |
pageToken |
선택사항입니다. 지정하면 위치의 다음 |
filter |
선택사항입니다. 반환할 위치를 제한하는 필터입니다. 응답에는 필터와 일치하는 항목만 포함됩니다. 유효한 입력란과 사용 예에 대한 자세한 내용은 위치 데이터 사용 가이드를 참고하세요. |
orderBy |
선택사항입니다. 요청의 정렬 순서입니다. 여러 필드는 SQL 구문에 따라 쉼표로 구분되어야 합니다. 기본 정렬 순서는 오름차순입니다. 내림차순을 지정하려면 접미사 ' desc'를 추가해야 합니다. orderBy에 유효한 필드는 title 및 storeCode입니다. 예: 'title, storeCode desc', 'title' 또는 'storeCode desc' |
readMask |
필수 항목입니다. 응답에서 반환될 필드를 지정하기 위해 마스크를 읽습니다. 필드의 정규화된 이름을 쉼표로 구분한 목록입니다. 예: |
요청 본문
요청 본문은 비어 있어야 합니다.
응답 본문
Locations.ListLocations의 응답 메시지입니다.
성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.
JSON 표현 |
---|
{
"locations": [
{
object ( |
필드 | |
---|---|
locations[] |
위치입니다. |
nextPageToken |
위치 수가 요청된 페이지 크기를 초과하면 이 필드는 |
totalSize |
페이지로 나누기와 관계없이 목록에 있는 대략적인 위치 수입니다. 이 필드는 |
승인 범위
다음 OAuth 범위가 필요합니다.
https://www.googleapis.com/auth/business.manage
자세한 내용은 OAuth 2.0 개요를 참고하세요.