지정된 기본 카테고리 및 국가가 있는 위치에 사용할 수 있는 속성 목록을 반환합니다.
HTTP 요청
GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes
URL은 gRPC 트랜스코딩 구문을 사용합니다.
쿼리 매개변수
매개변수 | |
---|---|
parent |
사용 가능한 속성을 조회할 위치의 리소스 이름입니다. 이 필드가 설정되면 categoryName, regionCode, languageCode 및 showAll이 필수가 아니며 설정하면 안 됩니다. |
categoryName |
사용 가능한 속성을 찾기 위한 기본 카테고리의 안정적인 ID입니다. 카테고리/{category_id} 형식이어야 합니다. |
regionCode |
사용 가능한 속성을 찾기 위한 ISO 3166-1 alpha-2 국가 코드입니다. |
languageCode |
속성 표시 이름을 가져올 BCP 47 언어 코드입니다. 이 언어를 사용할 수 없는 경우 영어로 제공됩니다. |
showAll |
이 필드가 true로 설정된 경우 상위 및 categoryName 필드를 무시하고 사용 가능한 모든 속성의 메타데이터가 반환됩니다. showAll이 true로 설정된 경우 languageCode 및 regionCode가 필요합니다. |
pageSize |
페이지당 포함할 속성 수입니다. 기본값은 200, 최솟값은 1입니다. |
pageToken |
지정하면 속성 메타데이터의 다음 페이지가 검색됩니다. |
요청 본문
요청 본문은 비어 있어야 합니다.
응답 본문
AttributesService.ListAttributeMetadata에 대한 응답입니다.
성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.
JSON 표현 |
---|
{
"attributeMetadata": [
{
object ( |
필드 | |
---|---|
attributeMetadata[] |
사용 가능한 속성의 속성 메타데이터 모음입니다. |
nextPageToken |
속성 수가 요청된 페이지 크기를 초과하면 이 필드는 |
승인 범위
다음 OAuth 범위가 필요합니다.
https://www.googleapis.com/auth/business.manage
자세한 내용은 OAuth 2.0 개요를 참고하세요.
AttributeMetadata
속성의 메타데이터입니다. 현지화된 이름과 관련 속성을 함께 그룹화하기 위한 제목을 비롯하여 속성의 표시 정보가 포함됩니다.
JSON 표현 |
---|
{ "parent": string, "valueType": enum ( |
필드 | |
---|---|
parent |
속성의 고유 식별자입니다. |
valueType |
속성의 값 유형입니다. 설정 및 검색된 값은 이 유형이어야 합니다. |
displayName |
사용할 수 있는 경우 속성의 현지화된 표시 이름입니다. 그렇지 않은 경우 영어 표시 이름입니다. |
groupDisplayName |
사용할 수 있는 경우 이 속성을 포함하는 그룹의 현지화된 표시 이름이고, 그렇지 않은 경우 영어 그룹 이름입니다. 관련 속성은 그룹으로 수집되며 여기에 제공된 제목 아래 함께 표시되어야 합니다. |
repeatable |
true인 경우 속성이 여러 값을 지원합니다. false인 경우 하나의 값만 제공해야 합니다. |
valueMetadata[] |
일부 속성 유형 (예: enum)의 경우 지원되는 값 목록과 이러한 값에 해당하는 표시 이름이 제공됩니다. |
deprecated |
true인 경우 속성은 지원 중단되었으며 더 이상 사용하면 안 됩니다. 지원 중단된 경우 이 속성을 업데이트해도 오류가 발생하지는 않지만 업데이트가 저장되지 않습니다. 지원 중단되면 어느 시점이 되면 속성이 완전히 삭제되고 오류가 됩니다. |
AttributeValueMetadata
지원되는 속성 값의 메타데이터입니다.
JSON 표현 |
---|
{ "value": value, "displayName": string } |
필드 | |
---|---|
value |
속성 값입니다. |
displayName |
이 값의 표시 이름으로, 가능한 경우 현지화되고 그렇지 않은 경우 영어입니다. 값 표시 이름은 속성 표시 이름과 함께 컨텍스트에서 사용하기 위한 것입니다. 예를 들어 'Wi-Fi' 열거형 속성의 경우 유료 Wi-Fi를 나타내는 'paid'가 포함될 수 있습니다. |