Q&A API가 출시되었습니다. 이전 작업이 필요하며, 지원 중단된 엔드포인트와 관련된 자세한 내용은 지원 중단 일정을 참고하세요.
Notifications API v1.1이 출시되었습니다. 자세한 내용은 변경 로그를 참고하세요. Google 메일링 리스트에 가입하면 업데이트 사항을 이메일로 받아볼 수 있습니다.

이 페이지는 Cloud Translation API를 통해 번역되었습니다.

Package google.mybusiness.placeactions.v1

색인

PlaceActions(인터페이스)
CreatePlaceActionLinkRequest(메시지)
DeletePlaceActionLinkRequest(메시지)
ErrorCode(열거형)
GetPlaceActionLinkRequest(메시지)
ListPlaceActionLinksRequest(메시지)
ListPlaceActionLinksResponse(메시지)
ListPlaceActionTypeMetadataRequest(메시지)
ListPlaceActionTypeMetadataResponse(메시지)
PlaceActionLink(메시지)
PlaceActionLink.ProviderType(열거형)
PlaceActionType(열거형)
PlaceActionTypeMetadata(메시지)
UpdatePlaceActionLinkRequest(메시지)

PlaceActions

이 API를 사용하면 업체 위치의 PlaceAction 링크를 관리할 수 있습니다.

CreatePlaceActionLink

CreatePlaceActionLink
`rpc CreatePlaceActionLink(CreatePlaceActionLinkRequest) returns (PlaceActionLink)` 지정된 위치와 연결된 작업 옵션 링크를 만들고 반환합니다. `parent`, `place_action_link.uri`, `place_action_link.place_action_type`가 이전 요청과 동일한 경우 중복 요청으로 간주됩니다. 승인 범위 다음 OAuth 범위가 필요합니다. `https://www.googleapis.com/auth/business.manage` 자세한 내용은 OAuth 2.0 개요를 참고하세요.

rpc CreatePlaceActionLink(CreatePlaceActionLinkRequest) returns (PlaceActionLink)

지정된 위치와 연결된 작업 옵션 링크를 만들고 반환합니다. parent, place_action_link.uri, place_action_link.place_action_type가 이전 요청과 동일한 경우 중복 요청으로 간주됩니다.

승인 범위

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

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

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

DeletePlaceActionLink

DeletePlaceActionLink
`rpc DeletePlaceActionLink(DeletePlaceActionLinkRequest) returns (Empty)` 지정된 위치에서 장소 작업 링크를 삭제합니다. 승인 범위 다음 OAuth 범위가 필요합니다. `https://www.googleapis.com/auth/business.manage` 자세한 내용은 OAuth 2.0 개요를 참고하세요.

rpc DeletePlaceActionLink(DeletePlaceActionLinkRequest) returns (Empty)

지정된 위치에서 장소 작업 링크를 삭제합니다.

승인 범위

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

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

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

GetPlaceActionLink

GetPlaceActionLink
`rpc GetPlaceActionLink(GetPlaceActionLinkRequest) returns (PlaceActionLink)` 지정된 작업 옵션 링크를 가져옵니다. 승인 범위 다음 OAuth 범위가 필요합니다. `https://www.googleapis.com/auth/business.manage` 자세한 내용은 OAuth 2.0 개요를 참고하세요.

rpc GetPlaceActionLink(GetPlaceActionLinkRequest) returns (PlaceActionLink)

지정된 작업 옵션 링크를 가져옵니다.

승인 범위

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

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

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

ListPlaceActionLinks

ListPlaceActionLinks
`rpc ListPlaceActionLinks(ListPlaceActionLinksRequest) returns (ListPlaceActionLinksResponse)` 지정된 위치의 작업 옵션 링크를 나열합니다. 승인 범위 다음 OAuth 범위가 필요합니다. `https://www.googleapis.com/auth/business.manage` 자세한 내용은 OAuth 2.0 개요를 참고하세요.

rpc ListPlaceActionLinks(ListPlaceActionLinksRequest) returns (ListPlaceActionLinksResponse)

지정된 위치의 작업 옵션 링크를 나열합니다.

승인 범위

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

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

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

ListPlaceActionTypeMetadata

rpc ListPlaceActionTypeMetadata(ListPlaceActionTypeMetadataRequest) returns (ListPlaceActionTypeMetadataResponse)

위치 또는 국가에 사용할 수 있는 장소 작업 유형 목록을 반환합니다.

승인 범위

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

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

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

UpdatePlaceActionLink

UpdatePlaceActionLink
`rpc UpdatePlaceActionLink(UpdatePlaceActionLinkRequest) returns (PlaceActionLink)` 지정된 작업 옵션 링크를 업데이트하고 반환합니다. 승인 범위 다음 OAuth 범위가 필요합니다. `https://www.googleapis.com/auth/business.manage` 자세한 내용은 OAuth 2.0 개요를 참고하세요.

rpc UpdatePlaceActionLink(UpdatePlaceActionLinkRequest) returns (PlaceActionLink)

지정된 작업 옵션 링크를 업데이트하고 반환합니다.

승인 범위

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

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

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

CreatePlaceActionLinkRequest

PlaceActions.CreatePlaceActionLink 요청 메시지입니다.

필드

필드
`parent`	`string` 필수 항목입니다. 이 장소 작업 링크를 만들 위치의 리소스 이름입니다. `locations/{location_id}`.
`place_action_link`	`PlaceActionLink` 필수 항목입니다. 만들 작업 링크입니다.

parent

string

필수 항목입니다. 이 장소 작업 링크를 만들 위치의 리소스 이름입니다. locations/{location_id}.

place_action_link

PlaceActionLink

필수 항목입니다. 만들 작업 링크입니다.

DeletePlaceActionLinkRequest

PlaceActions.DeletePlaceActionLink 요청 메시지입니다.

필드

필드
`name`	`string` 필수 항목입니다. 위치에서 삭제할 작업 옵션 링크의 리소스 이름입니다.

name

string

필수 항목입니다. 위치에서 삭제할 작업 옵션 링크의 리소스 이름입니다.

ErrorCode

내부 실패에 대한 오류 코드입니다.

열거형
`ERROR_CODE_UNSPECIFIED`	지정되지 않은 오류 코드입니다.
`UNVERIFIED_LOCATION`	위치가 인증되지 않았습니다.
`INVALID_LOCATION_CATEGORY`	위치 카테고리가 장소 작업 유형에 적합하지 않습니다. 오류를 일으킨 장소 작업 유형이 메타데이터에 반환되며, 키에는 'place_action_type' 문자열이, 값으로 `PlaceActionType` enum 값 문자열이 포함됩니다.
`INVALID_URL`	URL의 형식이 잘못되었거나 잘못되었습니다. 잘못된 작업 URL이 메타데이터에 반환되고 문자열 'url'이 키로, URL이 값으로 반환됩니다.
`URL_PROVIDER_NOT_ALLOWED`	URL에 허용되지 않는 제공업체가 있습니다. 허용되지 않은 장소 작업 URL이 문자열 'url'을 키로, URL을 값으로 하여 메타데이터에 반환됩니다.
`TOO_MANY_VALUES`	장소 작업 유형에 너무 많은 값이 설정되었습니다. 한도에 도달한 유형이 메타데이터에 'place_action_type' 문자열이 키, `PlaceActionType` enum 값 문자열이 값으로 반환됩니다.
`DELETED_LINK`	요청하신 작업 옵션 링크가 삭제되었습니다. 해당하는 URL이 메타데이터에 반환되며, 문자열 'url'이 키로, URL이 값으로 사용됩니다.
`LINK_ALREADY_EXISTS`	장소 작업 링크를 지정된 위치의 URI와 유형이 동일한 이미 존재하는 링크로 변환하기 위한 업데이트가 요청되고 있습니다.
`SCALABLE_DEEP_LINK_INVALID_MULTIPLICITY`	링크에 포함된 도메인이 이미 사용되었으며, 각 PlaceActionType에 도메인당 하나의 링크만 허용됩니다.
`LINK_DOES_NOT_EXIST`	지정된 링크가 데이터베이스에서 찾을 수 없습니다.

GetPlaceActionLinkRequest

PlaceActions.GetPlaceActionLink 요청 메시지입니다.

필드

필드
`name`	`string` 필수 항목입니다. 가져올 장소 작업 링크의 이름입니다.

name

string

필수 항목입니다. 가져올 장소 작업 링크의 이름입니다.

ListPlaceActionLinksRequest

PlaceActions.ListPlaceActionLinks 요청 메시지입니다. 이렇게 하면 위치의 작업 옵션 링크가 특정 순서 없이 나열됩니다. 이로 인해 Google 마이 비즈니스 웹사이트와 같은 다른 표시 경로를 통해 최근에 (지난 24시간 이내에) 생성된 링크가 반환되지 않을 수 있습니다. 생성된 지 24시간이 지난 링크는 이 API를 통해 표시됩니다.

필드
`parent`	`string` 필수 항목입니다. 작업 옵션 링크가 나열되는 위치의 이름입니다. `locations/{location_id}`.
`filter`	`string` 선택사항입니다. 반환되는 장소 작업 링크를 제한하는 필터입니다. 응답에는 필터와 일치하는 항목이 포함됩니다. Google에서는 1. place_action_type=XYZ 필터만 지원합니다. 여기서 XYZ는 유효한 PlaceActionType입니다.
`page_size`	`int32` 선택사항입니다. 페이지당 반환할 작업 옵션 링크의 수입니다. 기본값은 10입니다. 최솟값은 1입니다.
`page_token`	`string` 선택사항입니다. 지정하면 작업 옵션 링크의 다음 페이지를 반환합니다.

ListPlaceActionLinksResponse

PlaceActions.ListPlaceActionLinks의 응답 메시지입니다.

필드

필드
`place_action_links[]`	`PlaceActionLink` 작업 옵션 링크의 반환된 목록입니다.
`next_page_token`	`string` 요청된 페이지 크기보다 장소 작업 링크가 더 많은 경우 다음 결과 페이지를 가져오는 토큰으로 이 필드가 채워집니다.

place_action_links[]

PlaceActionLink

작업 옵션 링크의 반환된 목록입니다.

next_page_token

string

요청된 페이지 크기보다 장소 작업 링크가 더 많은 경우 다음 결과 페이지를 가져오는 토큰으로 이 필드가 채워집니다.

ListPlaceActionTypeMetadataRequest

PlaceActions.ListPlaceActionTypeMetadata 요청 메시지입니다. 결과는 특정 순서 없이 반환됩니다.

필드
`language_code`	`string` 선택사항입니다. 표시 이름을 가져올 IETF BCP-47 언어 코드입니다. 이 언어를 사용할 수 없는 경우 영어로 제공됩니다.
`page_size`	`int32` 선택사항입니다. 페이지당 포함할 액션 유형 수입니다. 기본값은 10, 최솟값은 1입니다.
`page_token`	`string` 선택사항입니다. 지정하면 장소 작업 유형 메타데이터의 다음 페이지가 검색됩니다. `placeActionTypeMetadata.list` 호출이 요청된 페이지 크기에 넣을 수 있는 것보다 많은 결과를 반환하는 경우 `pageToken`이 반환됩니다.
`filter`	`string` 선택사항입니다. 메타데이터를 반환하도록 장소 작업 유형을 제한하는 필터입니다. 응답에는 필터와 일치하는 항목이 포함됩니다. Google에서는 다음 필터만 지원합니다. 1. location=XYZ, 여기서 XYZ는 `locations/{location_id}` 형식으로 위치의 리소스 이름을 나타내는 문자열입니다. 2. region_code=XYZ, 여기서 XYZ는 사용 가능한 작업 유형을 찾기 위한 유니코드 CLDR 지역 코드입니다. 필터를 제공하지 않으면 모든 장소 작업 유형이 반환됩니다.

ListPlaceActionTypeMetadataResponse

PlaceActions.ListPlaceActionTypeMetadata의 응답 메시지입니다.

필드

place_action_type_metadata[]

PlaceActionTypeMetadata

사용 가능한 장소 작업 유형에 대한 메타데이터 모음입니다.

next_page_token

string

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

PlaceActionLink

작업 옵션 링크와 해당 속성을 나타냅니다.

필드
`name`	`string` 선택사항입니다. `locations/{location_id}/placeActionLinks/{place_action_link_id}` 형식의 리소스 이름입니다. name 필드는 각각 링크 업데이트 및 삭제를 위한 UpdatePlaceActionLink 및 DeletePlaceActionLink 요청에서만 고려됩니다. 그러나 CreatePlaceActionLink 요청에서는 새 링크가 성공적으로 생성되면 서버에서 `place_action_link_id`를 할당하고 응답의 일부로 반환합니다.
`provider_type`	`ProviderType` 출력 전용. 제공업체 유형을 지정합니다.
`is_editable`	`bool` 출력 전용. 클라이언트가 이 링크를 수정할 수 있는지 여부를 나타냅니다.
`uri`	`string` 필수 항목입니다. 링크 URI입니다. 동일한 URI를 여러 위치의 여러 작업 유형에 재사용할 수 있습니다. 그러나 (URI, 장소 작업 유형, 위치)의 고유한 조합마다 하나의 작업 옵션 링크만 허용됩니다.
`place_action_type`	`PlaceActionType` 필수 항목입니다. 이 링크를 사용하여 수행할 수 있는 장소 작업의 유형입니다.
`is_preferred`	`bool` 선택사항입니다. 판매자가 이 링크를 선호하는지 여부입니다. 한 위치에서 한 개의 링크만 장소 작업 유형당 선호로 표시할 수 있습니다. 향후 요청에서 동일한 장소 작업 유형에 대해 다른 링크를 선호 링크로 표시하면 현재 선호 링크 (있는 경우)의 환경설정이 삭제됩니다.
`create_time`	`Timestamp` 출력 전용. 작업 옵션 링크가 생성된 시간입니다.
`update_time`	`Timestamp` 출력 전용. 작업 옵션 링크가 마지막으로 수정된 시간입니다.

ProviderType

링크 제공자의 유형으로, 읽기만 가능합니다.

열거형
`PROVIDER_TYPE_UNSPECIFIED`	지정되지 않음
`MERCHANT`	퍼스트 파티 제공업체(예: 판매자 또는 판매자를 대신하는 대행사)
`AGGREGATOR_3P`	서드 파티 애그리게이터(예: `Reserve with Google` 파트너)

PlaceActionType

링크를 사용하여 수행할 수 있는 장소 작업의 유형입니다.

열거형
`PLACE_ACTION_TYPE_UNSPECIFIED`	지정되지 않음
`APPOINTMENT`	작업 유형이 예약입니다.
`ONLINE_APPOINTMENT`	작업 유형이 온라인 예약입니다.
`DINING_RESERVATION`	작업 유형이 식당 예약입니다.
`FOOD_ORDERING`	작업 유형이 배달 또는 테이크아웃 음식 주문입니다.
`FOOD_DELIVERY`	작업 유형이 배달 음식 주문입니다.
`FOOD_TAKEOUT`	작업 유형이 테이크아웃 음식 주문입니다.
`SHOP_ONLINE`	액션 유형은 쇼핑이며 배달 또는 수령이 될 수 있습니다.

PlaceActionTypeMetadata

지원되는 장소 작업 유형의 메타데이터입니다.

필드

place_action_type

PlaceActionType

장소 작업 유형입니다.

display_name

string

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

UpdatePlaceActionLinkRequest

PlaceActions.UpdatePlaceActionLink 요청 메시지입니다.

필드

필드
`place_action_link`	`PlaceActionLink` 필수 항목입니다. 업데이트된 작업 옵션 링크입니다.
`update_mask`	`FieldMask` 필수 항목입니다. 업데이트할 특정 필드입니다. 수정 가능한 필드는 `uri`, `place_action_type`, `is_preferred`뿐입니다. 업데이트된 링크가 이미 동일한 위치에 있고 `place_action_type` 및 `uri`가 동일한 경우 `ALREADY_EXISTS` 오류와 함께 실패합니다.

place_action_link

PlaceActionLink

필수 항목입니다. 업데이트된 작업 옵션 링크입니다.

update_mask

FieldMask

필수 항목입니다. 업데이트할 특정 필드입니다. 수정 가능한 필드는 uri, place_action_type, is_preferred뿐입니다. 업데이트된 링크가 이미 동일한 위치에 있고 place_action_type 및 uri가 동일한 경우 ALREADY_EXISTS 오류와 함께 실패합니다.