Method: attributes.list

지정된 기본 카테고리 및 국가가 있는 위치에 사용할 수 있는 속성 목록을 반환합니다.

HTTP 요청

GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes

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

쿼리 매개변수

파라미터
parent

string

선택사항입니다. 사용 가능한 속성을 조회할 위치의 리소스 이름입니다. 이 필드가 설정된 경우 categoryName, regionCode, languageCode, showAll는 필요하지 않으며 설정해서는 안 됩니다.

형식: locations/{locationId} (예: locations/1234567890)
categoryName

string

선택사항입니다. 사용 가능한 속성을 찾기 위한 기본 카테고리의 안정적인 ID입니다. categories/{category_id} 형식이어야 합니다(예: categories/gcid:restaurant). parent가 설정되지 않고 showAll가 false인 경우 필수입니다.
regionCode

string

선택사항입니다. 사용 가능한 속성을 찾기 위한 ISO 3166-1 alpha-2 국가 코드입니다. parent가 설정되지 않은 경우 필수입니다.
languageCode

string

선택사항입니다. 속성 표시 이름을 가져올 언어의 BCP 47 코드입니다. 이 언어를 사용할 수 없는 경우 영어로 제공됩니다.
showAll

boolean

선택사항입니다. true로 설정하면 parent 및 categoryName 필드를 무시하고 사용 가능한 모든 속성의 메타데이터가 반환됩니다. showAll가 true로 설정된 경우 languageCode 및 regionCode가 필요합니다.
pageSize

integer

페이지당 포함할 속성 수입니다. 기본값은 200, 최소는 1입니다.
pageToken

string

지정할 경우 속성 메타데이터의 다음 페이지가 검색됩니다.

요청 본문

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

응답 본문

AttributesService.ListAttributeMetadata의 응답입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
필드
attributeMetadata[]

object (AttributeMetadata)

사용 가능한 속성의 속성 메타데이터 모음입니다.
nextPageToken

string

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

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 Overview를 참조하세요.

AttributeMetadata

속성의 메타데이터입니다. 현지화된 이름과 관련 속성 그룹화를 위한 제목을 포함하여 속성의 표시 정보가 포함됩니다.

JSON 표현 
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
필드
parent

string

속성의 고유 식별자입니다.
valueType

enum (AttributeValueType)

속성의 값 유형입니다. 설정 및 검색된 값은 이 유형이라고 예상해야 합니다.
displayName

string

사용할 수 있는 경우 속성의 현지화된 표시 이름이고, 그렇지 않은 경우 영어 표시 이름입니다.
groupDisplayName

string

사용할 수 있는 경우 이 속성을 포함하는 그룹의 현지화된 표시 이름이고, 그렇지 않은 경우 영어 그룹 이름입니다. 관련 속성은 그룹으로 수집되며 여기에 제공된 제목 아래 함께 표시되어야 합니다.
repeatable

boolean

true인 경우 속성이 여러 값을 지원합니다. false인 경우 하나의 값만 제공해야 합니다.
valueMetadata[]

object (AttributeValueMetadata)

일부 속성 유형 (예: 열거형)의 경우, 지원되는 값 목록과 이러한 값의 해당 표시 이름이 제공됩니다.
deprecated

boolean

true인 경우 속성은 지원 중단되었고 더 이상 사용하면 안 됩니다. 지원 중단된 경우 이 속성을 업데이트해도 오류가 발생하지는 않지만 업데이트가 저장되지 않습니다. 지원 중단된 후 어느 시점에 속성이 완전히 삭제되고 오류가 발생합니다.

AttributeValueMetadata

지원되는 속성 값의 메타데이터입니다.

JSON 표현 
{
  "value": value,
  "displayName": string
}
필드
value

value (Value format)

속성 값입니다.
displayName

string

이 값의 표시 이름으로, 가능한 경우 현지화되고 그렇지 않은 경우 영어입니다. 값 표시 이름은 속성 표시 이름과 함께 사용됩니다.

예를 들어 'WiFi' enum 속성의 경우 유료 Wi-Fi를 나타내는 'Paid'가 포함될 수 있습니다.