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」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

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

RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

event

object (LocalPostEvent)

活動資訊。主題類型為 EVENTOFFER 的必要欄位。

state

enum (LocalPostState)

僅供輸出。貼文的狀態,表示其處於生命週期的哪個部分。

media[]

object (MediaItem)

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

searchUrl

string

僅供輸出。Google 搜尋結果中的當地貼文連結。你可以透過這類連結,在社群媒體、電子郵件、簡訊等管道分享貼文。

topicType

enum (LocalPostTopicType)

必要欄位。貼文的主題類型:標準、活動、優惠或快訊。

alertType

enum (AlertType)

建立貼文的快訊類型。這個欄位僅適用於 topicType Alert 的貼文,且行為是「Alert」(快訊) 的子類型。

offer

object (LocalPostOffer)

優惠貼文的其他資料。只有在 topicType 為 OFFER 時,才需要設定這個選項。

CallToAction

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

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

enum (ActionType)

要執行的動作類型。

url

string

使用者點擊後會連上的網址。若是來電行動號召,請勿設定這個欄位。

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.Dategoogle.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 貼文僅支援摘要欄位和行動號召欄位。這些快訊失效後,系統就不會為 COVID-19 類型建立新的快訊貼文。但商家仍可管理現有的 COVID-19 相關貼文。

LocalPostOffer

優惠貼文的專屬欄位。

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

string

選用設定。提供可於店內或線上使用的代碼。

redeemOnlineUrl

string

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

termsConditions

string

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

方法

create

建立並傳回與指定地點相關聯的新當地貼文。

delete

刪除本機貼文。

get

取得指定的當地文章。

list

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

patch

更新指定的當地文章,並傳回更新後的當地文章。

reportInsights

傳回與單一商家資訊相關的一系列當地貼文的深入分析。