Merchant API에는 전용 Homepage
리소스가 도입되었습니다. 이 리소스는 홈페이지 소유권을 관리하는 새로운 방법을 제공하며, 기존 Content API for Shopping을 넘어선 기능을 제공합니다.
온라인 상점의 기능에 액세스하려면 먼저 소유권을 확인한 다음 계정의 사이트 소유권을 주장하는 두 단계를 거쳐야 합니다. 마지막 단계를 완료하려면 accounts.homepage.claim
을 사용하세요.
주요 차이점
Merchant API는 Content API for Shopping과 비교하여 다음과 같은 홈페이지 관련 변경사항이 있습니다.
- 전용 리소스: Merchant API는 모든 홈페이지 관련 작업을 위해 별도의
Homepage
리소스(accounts.homepage
)를 제공합니다. (Content API for Shopping에서는accounts.claimwebsite
를 사용하여 소유권 주장 작업을 실행했고, 홈페이지 URL(website_url
)은Account
리소스의 일부였으며, 소유권 주장 상태(website_claimed
)는AccountStatus
리소스의 일부였습니다.) - 세부 메서드: Merchant API는 다음 작업을 수행하는 특정 메서드를 제공합니다.
- 홈페이지 세부정보 가져오기:
accounts.homepage.getHomepage
- 홈페이지 URI 업데이트:
accounts.homepage.updateHomepage
- 홈페이지 소유권 주장:
accounts.homepage.claim
- 홈페이지 부인:
accounts.homepage.unclaim
쇼핑용 Content API는accounts.claimwebsite
를 사용하여 부인 작업을 실행하고,accounts.update
를 사용하여 URL을 설정하며 (빈 URL을 설정하여 효과적으로 부인),accounts.get
/accountstatuses.get
를 사용하여 각각 URL과 부인 상태를 가져왔습니다.
- 홈페이지 세부정보 가져오기:
- 중앙 집중식 정보: Merchant API
Homepage
리소스에는uri
(홈페이지 URL)와claimed
상태가 모두 직접 포함됩니다.Homepage
리소스에서 작동하는 모든 메서드는 이 리소스를 반환하여 현재 상태에 관한 즉각적인 피드백을 제공합니다. Content API for Shopping에서는accounts.claimwebsite
가 업데이트된 상태를 반환하지 않았으며 별도의 호출이 필요했습니다. - 명시적 거부: Content API for Shopping에서 거부는 일반적으로
Account.website_url
을 빈 문자열로 업데이트하여 이루어졌습니다. Merchant API는 전용homepage.unclaim
메서드를 제공합니다. - 소유권 주장 덮어쓰기: 두 API 모두 소유권을 확인할 수 있는 경우 소유권 주장 프로세스 중에
overwrite
매개변수를 지원하여 다른 계정의 소유권을 주장할 수 있습니다.
요청
Merchant API는 홈페이지의 다양한 측면을 관리하기 위해 고유한 RESTful 엔드포인트를 사용합니다.
요청 설명 | Content API for Shopping for Shopping | Merchant API |
---|---|---|
홈페이지 세부정보 가져오기 | accounts.get (Account.website_url 읽기), accountstatuses.get (AccountStatus.website_claimed 읽기) |
GET /accounts/v1/accounts/{account}/homepage |
홈페이지 URI 업데이트 | accounts.update (Account.website_url 설정) |
PATCH /accounts/v1/accounts/{account}/homepage |
홈페이지 소유권 주장 또는 재인증 | POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (accounts.update 를 사용하여 설정된 Account.website_url 에 따라 조치를 취함) |
POST /accounts/v1/accounts/{account}/homepage:claim |
홈페이지 거부 | accounts.update (Account.website_url 을 빈 문자열로 설정) |
POST /accounts/v1/accounts/{account}/homepage:unclaim |
식별자
판매자 API에서 리소스 식별이 간소화되었습니다.
식별자 설명 | Content API for Shopping | Merchant API |
---|---|---|
리소스 액세스용 계정 식별자 | 경로의 merchantId (고급 계정) 및 accountId (하위 계정) |
account (name 필드의 일부, 예: accounts/{account_id}/homepage ) |
홈페이지 리소스 식별자 | 해당 사항 없음 (Account 리소스에 암시됨) |
name : accounts/{account_id}/homepage (Homepage 하위 리소스를 식별함) |
메서드
청구 작업에 중점을 둔 Content API for Shopping의 accounts.claimwebsite
메서드가 이제 Merchant API의 Homepage
리소스 내에 있는 더 광범위한 기능 집합의 일부가 되었습니다.
Content API for Shopping 메서드 | Merchant API 메서드 | 사용 가능 여부 및 참고사항 |
---|---|---|
accounts.claimwebsite |
accounts.homepage.claim |
웹사이트 소유권 주장을 직접 시작하거나 재인증합니다. homepage.update 를 사용하여 이전에 설정된 uri 에 따라 작동합니다. overwrite 매개변수가 포함됩니다. 현재 uri 및 claimed 상태가 포함된 Homepage 리소스를 반환합니다. |
accounts.get (Account.website_url 읽기), accountstatuses.get (AccountStatus.website_claimed 읽기) |
accounts.homepage.getHomepage |
단일 호출에서 현재 홈페이지 uri 와 claimed 상태를 가져오는 새로운 전용 메서드 |
accounts.update (Account.website_url 설정) |
accounts.homepage.updateHomepage |
홈페이지를 설정하거나 변경하는 새로운 전용 메서드 uri |
accounts.update (Account.website_url 을 빈 문자열로 설정하여 소유권을 해제하는 해결 방법) |
accounts.homepage.unclaim |
홈페이지의 소유권을 명시적으로 해제하는 새로운 전용 메서드 |
세부 필드 변경사항
홈페이지 정보가 구조화되고 액세스되는 방식이 크게 변경되어 Merchant API의 명시적 Homepage
리소스로 이동했습니다.
Content API for Shopping | Merchant API | 설명 |
---|---|---|
merchantId (accounts.claimwebsite 의 경로 매개변수) |
name (Homepage 메서드의 경로 매개변수, 형식: accounts/{account}/homepage ) |
Merchant API의 name 문자열 중 account 부분은 Content API for Shopping의 accountId 에 해당합니다. |
accountId (accounts.claimwebsite 의 경로 매개변수) |
name (Homepage 메서드의 경로 매개변수, 형식: accounts/{account}/homepage ) |
홈페이지가 관리되는 특정 계정의 식별자입니다. |
overwrite (ContentAccountsClaimwebsiteRequest 본문 및 AccountsCustomBatchRequestEntry 의 불리언) |
ClaimHomepageRequest.overwrite (homepage.claim 요청 본문의 불리언) |
선택사항입니다. true 가 웹사이트의 소유권을 주장하려고 시도하며, 요청 계정에서 소유권을 확인할 수 있는 경우 다른 계정의 기존 소유권 주장을 삭제할 수 있습니다. |
Account.website_url (Account 리소스의 필드, accounts.update 를 사용하여 설정, accounts.get 를 사용하여 읽기) |
Homepage.uri (Homepage 리소스의 필드) |
매장 홈페이지의 URI (URL)입니다. 판매자 API에서 이는 Homepage 리소스 내의 명시적 필드입니다. accounts.homepage.updateHomepage 를 사용하여 설정되고 모든 Homepage 메서드에서 반환됩니다. |
AccountStatus.website_claimed (AccountStatus 리소스의 필드, accountstatuses.get 를 사용하여 읽음) |
Homepage.claimed (Homepage 리소스의 output_only 불리언 필드) |
uri 가 소유권 주장되고 인증되었는지 여부를 나타냅니다. 이 상태는 연결된 모든 Merchant API 메서드에서 반환된 Homepage 리소스에서 직접 확인할 수 있습니다. |
해당 사항 없음 | UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage 요청 본문 매개변수) |
homepage.update 의 선택적 필드 마스크로, Homepage 리소스의 uri )가 업데이트되고 있습니다. |