REST Resource: accounts.businessInfo

리소스: BusinessInfo

BusinessInfo 메시지에는 판매자의 비즈니스에 관한 필수 정보가 포함되어 있습니다.

이 메시지에는 실제 주소, 고객 서비스 담당자, 지역별 식별자와 같은 주요 비즈니스 세부정보가 포함됩니다.

JSON 표현 
{
  "name": string,
  "address": {
    object (PostalAddress)
  },
  "phone": {
    object (PhoneNumber)
  },
  "phoneVerificationState": enum (PhoneVerificationState),
  "customerService": {
    object (CustomerService)
  },
  "koreanBusinessRegistrationNumber": string
}
필드
name

string

식별자. 비즈니스 정보의 리소스 이름입니다. 형식: accounts/{account}/businessInfo
address

object (PostalAddress)

선택사항입니다. 비즈니스 주소입니다. regionCode, addressLines, postalCode, administrativeArea, locality 필드만 지원됩니다. 다른 모든 필드는 무시됩니다.
phone

object (PhoneNumber)

출력 전용입니다. 비즈니스의 전화번호
phoneVerificationState

enum (PhoneVerificationState)

출력 전용입니다. 비즈니스의 전화 인증 상태입니다.
customerService

object (CustomerService)

선택사항입니다. 비즈니스의 고객 서비스입니다.
koreanBusinessRegistrationNumber

string

선택사항입니다. XXX-XX-XXXXX 형식의 대시로 구분된 10자리 대한민국 사업자등록번호입니다.

PostalAddress

우편 배달 주소나 수취인 주소와 같은 우편 주소를 나타냅니다. 우편 주소가 있으면 우체국이 사업장, 사서함 또는 이와 유사한 주소로 물건을 배달할 수 있습니다. 도로, 마을, 산 등 지리적 위치를 모델링하기 위한 것은 아닙니다.

일반적인 경우 주소는 프로세스 유형에 따라 사용자 입력을 통해 또는 기존 데이터를 가져와 생성됩니다.

주소 입력 / 수정에 관한 조언: - https://github.com/google/libaddressinput과 같은 다국어 지원 주소 위젯을 사용하세요. - 필드가 사용되는 국가 밖에서 해당 필드를 입력 또는 수정할 수 있는 UI 요소가 사용자에게 표시되어서는 안 됩니다.

이 스키마를 사용하는 방법에 대한 자세한 내용은 https://support.google.com/business/answer/6397478을 참고하세요.

JSON 표현 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
필드
revision

integer

PostalAddress의 스키마 버전입니다. 최신 버전을 나타내는 0으로 설정해야 합니다.

모든 새 버전은 이전 버전과 반드시 호환되어야 합니다.
regionCode

string

필수 항목입니다. 주소의 국가/지역에 해당하는 CLDR 지역 코드입니다. 이 코드는 추론되지 않으며, 값의 정확성은 사용자의 책임입니다. 자세한 내용은 https://cldr.unicode.org/ 및 https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html을 참고하세요. 예: 스위스의 경우 'CH'.
languageCode

string

선택사항입니다. 이 주소 콘텐츠의 BCP-47 언어 코드입니다 (알려진 경우). 종종 입력 양식의 UI 언어이거나 주소의 국가/지역에서 사용되는 언어 중 하나 또는 음역된 언어와 일치해야 합니다. 이는 일부 국가에서 형식을 갖추는 데 영향을 줄 수 있지만 데이터의 정확성에는 중요하지 않으며, 유효성 검사 작업이나 형식을 갖추는 것과 관련 없는 기타 작업에는 영향이 없습니다.

이 값을 알 수 없다면 잘못될 가능성이 있는 기본값을 지정하는 대신 이 값을 생략해야 합니다.

예: 'zh-Hant', 'ja', 'ja-Latn', 'en'.
postalCode

string

선택사항입니다. 주소의 우편번호입니다. 모든 국가에서 우편번호를 사용하거나 우편번호가 있어야 하는 것은 아니지만 사용되는 경우 주소 다른 부분의 추가 유효성 검사 (예: 미국의 주/우편번호 유효성 검사)가 트리거될 수 있습니다.
sortingCode

string

선택사항입니다. 국가별 추가 정렬 코드입니다. 대부분의 지역에서는 사용되지 않습니다. 이 필드가 사용되는 경우 값은 'CEDEX'와 같은 문자열(선택적으로 숫자 뒤에 오는 경우(예: 'CEDEX 7')) 또는 '섹터 코드'(자메이카), '배송 지역 지표'(말라위) 또는 '우체국 지표'(예: 코트디부아르)를 나타내는 숫자만으로 구성됩니다.
administrativeArea

string

선택사항입니다. 국가 또는 지역의 우편 주소에 사용되는 최상위 행정 구역 단위입니다. 예를 들어 미국의 주, 캐나다의 주, 구소련의 주 또는 프랑스의 도가 될 수 있습니다. 구체적으로 스페인의 경우에는 광역 자치주가 아니라 주(province)입니다(예: '카탈로니아'가 아니라 '바르셀로나'). 많은 국가에서는 우편 주소에 행정 구역을 사용하지 않습니다. 예를 들어 스위스에서는 이 필드를 채우지 않은 상태로 두어야 합니다.
locality

string

선택사항입니다. 일반적으로 주소의 시/군/구 부분을 나타냅니다. 예: 미국 시, 이탈리아 코무네, 영국 포스트타운. 지역이 잘 정의되지 않거나 이 구조에 잘 맞지 않는 경우 지역을 비워 두고 addressLines를 사용합니다.
sublocality

string

선택사항입니다. 주소의 하위 지역입니다. 예를 들어 인근 지역, 자치구, 구일 수 있습니다.
addressLines[]

string

주소의 하위 수준을 설명하는 구조화되지 않은 주소 입력란입니다.

addressLines의 값에는 형식 정보가 없고 경우에 따라 하나의 필드에 여러 값이 포함될 수 있으므로 (예: 'Austin, TX') 행 순서가 명확해야 합니다. 주소 입력란 순서는 주소의 국가/지역의 '봉투 순서'여야 합니다. 이것이 달라질 수 있는 곳 (예: 일본)에서는 address_language를 사용하여 명시적으로 만듭니다 (예: 큰 단위에서 작은 단위 순서는 'ja', 작은 단위에서 큰 단위 순서는 'ja-Latn' 또는 'en'). 이렇게 하면 언어를 기준으로 가장 구체적인 주소 입력란을 선택할 수 있습니다.

주소에 허용되는 최소 구조 표시는 나머지 모든 정보가 addressLines에 배치된 regionCode로 구성됩니다. 이러한 주소를 지오코딩 없이 상당히 비슷하게 형식을 갖출 수도 있지만 최소한 부분적으로 확인될 때까지는 어떤 주소 구성요소에 대해서도 의미 추론을 할 수 없습니다.

주소 중 지역에 해당하는 부분과 행정 구역에 해당하는 부분을 추측하는 대신 regionCode와 addressLines만 포함된 주소를 만든 다음 지오코딩하는 것이 전혀 구조화되지 않은 주소를 처리하는 방법으로 좋습니다.
recipients[]

string

선택사항입니다. 주소의 수신자입니다. 경우에 따라 이 필드에 여러 줄로 구성된 정보가 포함될 수 있습니다. 예를 들어 '전교' 정보가 포함될 수 있습니다.
organization

string

선택사항입니다. 주소에 있는 조직의 이름입니다.

전화번호

API 전송 형식으로 적합한 전화번호를 나타내는 객체입니다.

이 표현은 다음과 같습니다.

  • 전화번호의 언어별 형식 지정(예: '+1 (650) 253-0000 ext. 123')에는 사용해서는 안 됩니다.

  • 효율적인 저장용으로 설계되지 않음

  • 전화 걸기에 적합하지 않을 수 있습니다. 이 용도로 번호를 파싱하려면 특수 라이브러리 (참조 참고)를 사용해야 합니다.

이 숫자로 의미 있는 작업을 하려면(예: 다양한 사용 사례에 맞게 형식 지정) 먼저 i18n.phonenumbers.PhoneNumber 객체로 변환하세요.

예를 들어 Java에서는 다음과 같습니다.

com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); }

참조: - https://github.com/google/libphonenumber

JSON 표현 
{
  "extension": string,

  // Union field kind can be only one of the following:
  "e164Number": string,
  "shortCode": {
    object (ShortCode)
  }
  // End of list of possible types for union field kind.
}
필드
extension

string

전화번호의 부번입니다. 이 확장자는 최대 길이가 40자리인 일련의 숫자로 정의되는 것을 제외하고 ITU 권장사항에서 표준화되지 않습니다. 숫자 외에도 ',' (대기 중임을 나타냄) 또는 '#'과 같은 다른 다이얼링 문자가 여기에 저장될 수 있습니다.

현재 어떤 지역에서도 쇼트 코드와 함께 확장자를 사용하지 않으므로 이 필드는 일반적으로 E.164 번호와 함께만 설정됩니다. 향후 쇼트 코드 확장이 가능하도록 E.164 번호와 별도로 보관됩니다.
통합 필드 kind. 필수 항목입니다. 일반 전화번호 또는 쇼트 코드입니다. 향후 아래의 oneof에 새 필드가 추가될 수 있으므로 클라이언트는 코딩한 필드가 설정되지 않은 전화번호를 무시해야 합니다. kind은 다음 중 하나여야 합니다.
e164Number

string

전화번호는 선행 더하기 기호('+')로 표시되며, 그 뒤에 국가 전화번호(1~3자리)와 구독자 번호로 구성된 완화된 ITU E.164 형식의 전화번호가 추가 공백이나 형식 없이 표시됩니다(예: - 올바른 형식: '+15552220123' - 잘못된 형식: '+1 (555) 222-01234 x123'

ITU E.164 형식에서는 후자를 12자리로 제한하지만 실제로는 모든 국가에서 이를 준수하지 않으므로 여기서는 이 제한을 완화합니다. 국내 전용 번호는 허용되지 않습니다.

참고자료: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
shortCode

object (ShortCode)

쇼트 코드

참조: - https://en.wikipedia.org/wiki/Short_code

ShortCode

일반적으로 일반 전화번호보다 훨씬 짧은 전화번호로, MMS 및 SMS 시스템의 메시지 주소 지정과 축약된 다이얼링 (예: '611번으로 문자 메시지를 보내면 요금제에 남은 분량을 확인할 수 있습니다.')에 사용할 수 있는 쇼트 코드를 나타내는 객체입니다.

단축 코드는 특정 지역으로 제한되며 국제 전화를 걸 수 없습니다. 즉, 동일한 단축 코드가 여러 지역에 존재할 수 있으며, 이러한 지역이 동일한 국가 전화 코드를 공유하더라도 (예: 미국 및 캐나다) 사용량과 가격이 다를 수 있습니다.

JSON 표현 
{
  "regionCode": string,
  "number": string
}
필드
regionCode

string

필수 항목입니다. 이 쇼트 코드로 전화를 걸 수 있는 위치의 BCP-47 지역 코드입니다(예: 'US', 'BB').

참조: - http://www.unicode.org/reports/tr35/#unicode_region_subtag
number

string

필수 항목입니다. 앞에 더하기 기호('+')나 국가 전화번호가 없는 단축 코드 숫자입니다(예: '611').

PhoneVerificationState

전화 인증 상태입니다.

열거형
PHONE_VERIFICATION_STATE_UNSPECIFIED 기본값 이 값은 사용되지 않습니다.
PHONE_VERIFICATION_STATE_VERIFIED 휴대전화가 인증되었습니다.
PHONE_VERIFICATION_STATE_UNVERIFIED 휴대전화가 인증되지 않음

CustomerService

고객 서비스 정보

JSON 표현 
{
  "uri": string,
  "email": string,
  "phone": {
    object (PhoneNumber)
  }
}
필드
uri

string

선택사항입니다. 고객 서비스를 찾을 수 있는 URI입니다.
email

string

선택사항입니다. 고객 서비스에 연락할 수 있는 이메일 주소입니다.
phone

object (PhoneNumber)

선택사항입니다. 고객 서비스에 전화를 걸 수 있는 전화번호입니다.

메서드

getBusinessInfo

 계정의 비즈니스 정보를 가져옵니다.

updateBusinessInfo

 계정의 비즈니스 정보를 업데이트합니다.