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)

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

searchUrl

string

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

topicType

enum (LocalPostTopicType)

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

alertType

enum (AlertType)

要建立貼文的快訊類型。這個欄位僅適用於 topicType 快訊 貼文,運作方式屬於「快訊」的子類型。

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 貼文僅支援摘要欄位和行動號召欄位。如果這些快訊不再相關,就會停用建立 COVID-19 類型的新快訊。不過,商家仍可管理現有的 COVID-19 貼文。

LocalPostOffer

優惠貼文的特定欄位。

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

string

選用設定。可在店面或線上提供的優惠代碼。

redeemOnlineUrl

string

選用設定。線上兌換連結。

termsConditions

string

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

方法

create

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

delete

刪除本機貼文。

get

取得指定的當地貼文。

list

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

patch

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

reportInsights

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