REST Resource: accounts.locations.localPosts

リソース: LocalPost

ビジネスについてのローカル投稿を表します。

JSON 表現 
{
  "name": string,
  "languageCode": string,
  "summary": string,
  "callToAction": {
    object (CallToAction)
  },
  "createTime": string,
  "updateTime": string,
  "scheduledTime": string,
  "recurringInstanceTime": string,
  "event": {
    object (LocalPostEvent)
  },
  "state": enum (LocalPostState),
  "media": [
    {
      object (MediaItem)
    }
  ],
  "searchUrl": string,
  "topicType": enum (LocalPostTopicType),
  "alertType": enum (AlertType),

  // Union field topic_type_specific_fields can be only one of the following:
  "offer": {
    object (LocalPostOffer)
  }
  // End of list of possible types for union field topic_type_specific_fields.
}
フィールド
name

string

出力専用。このローカル投稿を accounts/{accountId}/locations/{locationId}/localPosts/{local_post_id} の形式で表した Google 識別子です。
languageCode

string

ローカル投稿の言語。
summary

string

ローカル投稿の説明文または本文。
callToAction

object (CallToAction)

プロモーションをクリックしたユーザーが誘導される URL です。トピックタイプが OFFER の場合は無視されます。
createTime

string (Timestamp format)

出力専用。投稿が作成された時間です。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。ユーザーが最後に投稿を変更した時間です。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
scheduledTime

string (Timestamp format)

設定されている場合、投稿が公開される日時を決定します。ユーザーが設定して、投稿を事前にスケジュールできます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
recurringInstanceTime
(deprecated)

string (Timestamp format)

出力専用。非推奨: 代わりに、event.recurring_instance_time を使用してください。このフィールドは今後のバージョンで削除される予定です。出力専用。投稿の最新の定期的なインスタンスが更新された時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
event

object (LocalPostEvent)

イベント情報。トピックタイプ EVENT と OFFER では必須です。
state

enum (LocalPostState)

出力専用。投稿がライフサイクルのどの段階にあるのかを表すステータスです。
media[]

object (MediaItem)

投稿に関連付けられているメディアです。LocalPost MediaItem でサポートされているデータ フィールドは sourceUrl のみです。
searchUrl

string

出力専用。Google 検索のローカル投稿へのリンクです。このリンクは、ソーシャル メディア、メール、テキスト メッセージなどで投稿を共有するために使用できます。
topicType

enum (LocalPostTopicType)

必須。投稿のトピックタイプ（標準、イベント、特典、アラート）です。
alertType

enum (AlertType)

投稿を作成するアラートの種類。このフィールドは、topicType が Alert の投稿にのみ適用され、アラートのサブタイプとして機能します。
共用体フィールド topic_type_specific_fields。トピックタイプの特定のフィールド。topic_type_specific_fields は次のいずれかになります。
offer

object (LocalPostOffer)

特典に関する投稿の追加データです。topicType が OFFER の場合にのみ設定する必要があります。

CallToAction

ユーザーが投稿をクリックしたときに実行されるアクション。

JSON 表現 
{
  "actionType": enum (ActionType),
  "url": string
}
フィールド
actionType

enum (ActionType)

実行されるアクションのタイプ。
url

string

クリックしたときにユーザーに表示される URL です。電話による問い合わせを促すフレーズでは、このフィールドを未設定のままにする必要があります。

ActionType

実行されるアクションのタイプ。

列挙型
ACTION_TYPE_UNSPECIFIED 未指定
BOOK お店やレストランなどの予約を促します。
ORDER 注文を行うよう促します。
SHOP 商品カタログを閲覧するよう促します。
LEARN_MORE ウェブサイトで詳細を確認するよう促します。
SIGN_UP 登録、申し込み、参加を促します。
GET_OFFER

非推奨です。特典のコンテンツを含む投稿を作成するには、LocalPostTopicType で OFFER を使用します。
CALL ビジネスへの電話による問い合わせを促します。

LocalPostEvent

ローカル投稿に掲載されるイベントに関連するすべての情報です。

JSON 表現 
{
  "title": string,
  "schedule": {
    object (TimeInterval)
  },
  "recurrenceInfo": {
    object (RecurrenceInfo)
  },
  "recurringInstanceTime": string
}
フィールド
title

string

イベントの名前。
schedule

object (TimeInterval)

イベントの開始日時と終了日時。
recurrenceInfo

object (RecurrenceInfo)

省略可。定期的な投稿の頻度に関する情報を保存します。投稿が定期的な投稿の場合にのみ設定されます。
recurringInstanceTime

string (Timestamp format)

出力専用。投稿の最新の定期的なインスタンスが更新された時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

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)

この期間の終了時間。

日付

誕生日などのように、カレンダーの日付全体またはその一部を表します。時間帯とタイムゾーンは、他の場所で指定されているか、重要ではありません。日付は西暦を基準にしており、これは次のいずれかを表します。

  • 年の値がゼロ以外である月と日の値を含む完全な日付
  • 年の値がゼロである月と日（記念日など）。
  • 月と日の値がゼロである単独の年。
  • 日の値がゼロである年と月（クレジット カードの有効期限など）

関連するタイプ:

JSON 表現 
{
  "year": integer,
  "month": integer,
  "day": integer
}
フィールド
year

integer

その日付の年。1～9999、または年のない日付を指定する場合は 0 にする必要があります。
month

integer

1 年の中の月。1～12、または月と日のない年を指定する場合は 0 にする必要があります。
day

integer

1 月の中の日付。1～31 で、その年と月で有効な値にする必要があります。または、日が重要でない場合は年のみか年と月を指定するには 0 にする必要があります。

TimeOfDay

1 日のうちの時間を表します。日付とタイムゾーンは重要ではないか、他の場所で指定されています。API は、うるう秒を許可するようにできます。関連する型は、google.type.Date と google.protobuf.Timestamp です。

JSON 表現 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
フィールド
hours

integer

1 日の時間（24 時間形式）。0 以上にする必要があります。通常は 23 以下にする必要があります。API ではビジネスの終了時間などのシナリオにおいて、値 "24:00:00" を許可することもできます。
minutes

integer

1 時間の分。0 以上 59 以下にする必要があります。
seconds

integer

1 分の秒数。0 以上にする必要があります。通常は 59 以下にする必要があります。API がうるう秒を許可する場合、値 60 が許可されます。
nanos

integer

秒の小数部分（ナノ秒単位）。0 以上 999,999,999 以下にする必要があります。

RecurrenceInfo

ローカル投稿の定期的な投稿に関する情報を表します。

JSON 表現 
{
  "seriesEndTime": string,

  // Union field occurrence_pattern can be only one of the following:
  "dailyPattern": {
    object (DailyOccurrencePattern)
  },
  "weeklyPattern": {
    object (WeeklyOccurrencePattern)
  },
  "monthlyPattern": {
    object (MonthlyOccurrencePattern)
  }
  // End of list of possible types for union field occurrence_pattern.
}
フィールド
seriesEndTime

string (Timestamp format)

省略可。定期的なシリーズの終了時間。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
共用体フィールド occurrence_pattern。定期的な投稿の発生パターン。occurrence_pattern は次のいずれかになります。
dailyPattern

object (DailyOccurrencePattern)

毎日の発生パターン。
weeklyPattern

object (WeeklyOccurrencePattern)

週単位の発生パターン。
monthlyPattern

object (MonthlyOccurrencePattern)

月単位の発生パターン。

DailyOccurrencePattern

この型にはフィールドがありません。

毎日の発生パターンを表します。

WeeklyOccurrencePattern

週単位の繰り返しパターンを表します。

JSON 表現 
{
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
フィールド
daysOfWeek[]

enum (DayOfWeek)

省略可。特典/イベントの曜日リスト。空の場合、投稿はイベントの schedule.start_time と同じ曜日に繰り返されます。

DayOfWeek

曜日を表します。

列挙型
DAY_OF_WEEK_UNSPECIFIED 曜日は指定されていません。
MONDAY 月曜日
TUESDAY 火曜日
WEDNESDAY Wednesday
THURSDAY 木曜日
FRIDAY 金曜日
SATURDAY 土曜日
SUNDAY 日曜日

MonthlyOccurrencePattern

月単位の繰り返しパターンを表します。

JSON 表現 
{

  // Union field monthly_option can be only one of the following:
  "dayOfMonth": integer,
  "dayOfWeekOccurrence": enum (DayOfWeekOccurrence)
  // End of list of possible types for union field monthly_option.
}
フィールド
共用体フィールド monthly_option。月単位の繰り返しパターンの繰り返しオプション。monthly_option は次のいずれかになります。
dayOfMonth

integer

日にちです。
dayOfWeekOccurrence

enum (DayOfWeekOccurrence)

月の曜日。曜日は、イベントの開始時間の曜日から推測されます。たとえば、イベントが金曜日に開始され、dayOfWeekOccurrence が SECOND の場合、イベントは毎月第 2 金曜日に繰り返されます。

DayOfWeekOccurrence

月の曜日。

列挙型
DAY_OF_WEEK_OCCURRENCE_UNSPECIFIED 指定されていない曜日の発生。
FIRST 月の最初の曜日。
SECOND 月の 2 番目の曜日。
THIRD 月の 3 番目の曜日。
FOURTH その月の 4 番目の曜日。
LAST 月の最終日。

LocalPostState

投稿のステータスを表します。

列挙型
LOCAL_POST_STATE_UNSPECIFIED ステータスが指定されていません。
REJECTED この投稿は、コンテンツ ポリシー違反により不承認となっています。
LIVE この投稿は公開されており、検索結果に現在表示されています。
PROCESSING この投稿は処理中で、検索結果に表示されていません。
SCHEDULED この投稿は将来の投稿としてスケジュールされており、検索結果に表示されていません。
RECURRING この投稿は定期的な投稿であり、検索結果に現在表示されています。

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

 指定したローカル投稿を更新し、更新されたローカル投稿を返します。