REST Resource: accounts.locations.localPosts

資源：LocalPost

代表某個地點的店面貼文。

JSON 表示法 
{
  "name": string,
  "languageCode": string,
  "summary": string,
  "callToAction": {
    object (CallToAction)
  },
  "createTime": string,
  "updateTime": string,
  "event": {
    object (LocalPostEvent)
  },
  "state": enum (LocalPostState),
  "media": [
    {
      object (MediaItem)
    }
  ],
  "searchUrl": string,
  "topicType": enum (LocalPostTopicType),
  "alertType": enum (AlertType),
  "offer": {
    object (LocalPostOffer)
  }
}
欄位
name

string

僅供輸出。這則本地貼文的 Google ID，格式如下：accounts/{accountId}/locations/{locationId}/localPosts/{localPostId}
languageCode

string

當地貼文的語言。
summary

string

區域貼文的說明/內文。
callToAction

object (CallToAction)

使用者點選促銷活動後會前往的網址。主題類型 OFFER 會忽略這項屬性。
createTime

string (Timestamp format)

僅供輸出。貼文建立時間。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如 "2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

僅供輸出。使用者上次修改貼文的時間。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如 "2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
event

object (LocalPostEvent)

事件資訊。主題類型 EVENT 和 OFFER 必須提供此項目。
state

enum (LocalPostState)

僅供輸出。貼文的狀態，指出貼文處於生命週期的哪個階段。
media[]

object (MediaItem)

與貼文相關聯的媒體。sourceUrl 是 LocalPost MediaItem 唯一支援的資料欄位。
searchUrl

string

僅供輸出。在 Google 搜尋中，連結至當地貼文。你可以透過社群媒體、電子郵件、簡訊等方式分享貼文。
topicType

enum (LocalPostTopicType)

必要欄位。貼文的主題類型：標準、活動、優惠或警報。
alertType

enum (AlertType)

建立貼文的快訊類型。這個欄位僅適用於 topicType 為 Alert 的貼文，並且會以快訊的子類型運作。
offer

object (LocalPostOffer)

優惠貼文的其他資料。只有在 topicType 為 OFFER 時，才應設定這個屬性。

CallToAction

使用者點按貼文時執行的動作

JSON 表示法 
{
  "actionType": enum (ActionType),
  "url": string
}
欄位
actionType

enum (ActionType)

要執行的動作類型。
url

string

使用者按下後會連到的網址。如果是電話號碼 CTA，請勿設定這個欄位。

ActionType

要執行的動作類型。

列舉
ACTION_TYPE_UNSPECIFIED 未指定類型。
BOOK 這則貼文希望使用者預約/訂位/等。
ORDER 這則貼文希望使用者下單。
SHOP 這則貼文希望使用者瀏覽產品目錄。
LEARN_MORE 這篇文章希望使用者前往網站瞭解詳情。
SIGN_UP 這則貼文要求使用者註冊/訂閱/加入某項服務。
GET_OFFER

已淘汰，在 LocalPostTopicType 中使用 OFFER，即可建立含有商品內容的貼文。
CALL 這則貼文希望使用者撥打電話給商家。

LocalPostEvent

本地貼文中所列活動的所有相關資訊。

JSON 表示法 
{
  "title": string,
  "schedule": {
    object (TimeInterval)
  }
}
欄位
title

string

事件名稱。
schedule

object (TimeInterval)

活動開始和結束日期/時間。

TimeInterval

時間間隔 (包含在內)。必須包含所有欄位才能有效。

JSON 表示法 
{
  "startDate": {
    object (Date)
  },
  "startTime": {
    object (TimeOfDay)
  },
  "endDate": {
    object (Date)
  },
  "endTime": {
    object (TimeOfDay)
  }
}
欄位
startDate

object (Date)

這段期間的開始日期。
startTime

object (TimeOfDay)

這個期間的開始時間。
endDate

object (Date)

這個期間的結束日期。
endTime

object (TimeOfDay)

這個期間的結束時間。

TimeOfDay

代表一天中的時間。日期和時區並不需要指定，或是在其他位置上指定。API 可選擇允許閏秒。相關類型為 google.type.Date 和 google.protobuf.Timestamp。

JSON 表示法 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
欄位
hours

integer

一天中的小時，採用 24 小時制。值應介於 0 到 23 之間。API 可選擇允許使用「24:00:00」這類的值來表示營業打烊時間等情況。
minutes

integer

一天中，每小時內的分鐘。值必須介於 0 到 59 之間。
seconds

integer

在當下時間中，該分鐘的秒數。正常情況下，值必須介於 0 到 59 之間。如果 API 允許閏秒，則可允許值為 60。
nanos

integer

秒數的小數，以奈秒為單位。值必須介於 0 到 999,999,999 之間。

LocalPostState

表示貼文的狀態

列舉
LOCAL_POST_STATE_UNSPECIFIED 未指定狀態。
REJECTED 這則貼文因違反內容政策而遭拒。
LIVE 這則貼文已發布，目前會顯示在搜尋結果中。
PROCESSING 這則貼文正在處理中，因此不會顯示在搜尋結果中。

LocalPostTopicType

本機貼文的主題類型，用於選取不同的範本來建立及轉譯貼文。

列舉
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED 未指定任何貼文類型。
STANDARD 貼文包含摘要和圖片等基本資訊。
EVENT 貼文包含基本資訊和事件。
OFFER 貼文包含基本資訊、活動和優惠相關內容 (例如優待券代碼)
ALERT 與持續性事件相關的優先順序高且及時的公告。這類貼文不一定能編寫。

AlertType

建立快訊貼文的事件類型。

列舉
ALERT_TYPE_UNSPECIFIED 未指定快訊。
COVID_19 與 2019 年冠狀病毒疾病疫情相關的警報。COVID-19 貼文僅支援摘要欄位和行動號召欄位。當這些快訊不再相關時，系統就會停用 COVID-19 類型的新快訊貼文建立功能。不過，商家仍可管理現有的 COVID-19 貼文。

LocalPostOffer

優惠貼文的特定欄位。

JSON 表示法 
{
  "couponCode": string,
  "redeemOnlineUrl": string,
  "termsConditions": string
}
欄位
couponCode

string

選用設定。可在實體店面或線上使用的優惠代碼。
redeemOnlineUrl

string

選用設定。兌換優惠的線上連結。
termsConditions

string

選用設定。優惠條款及細則。

方法

create

 建立與指定地點相關聯的新本機貼文，並傳回該貼文。

delete

 刪除本機貼文。

get

 取得指定的本機郵件。

list

 傳回與地點相關的當地貼文清單。

patch

 更新指定的店面貼文，並傳回更新後的店面貼文。

reportInsights

 傳回與單一商家資訊相關的一組店面貼文洞察資料。