REST Resource: accounts.locations.localPosts

Recurso: LocalPost

Representa uma postagem local de um local.

Representação 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.
}
Campos
name

string

Apenas saída. Identificador do Google para esta postagem no formato: accounts/{accountId}/locations/{locationId}/localPosts/{local_post_id}
languageCode

string

O idioma da postagem local.
summary

string

Descrição/corpo da postagem local.
callToAction

object (CallToAction)

O URL para o qual os usuários são direcionados ao clicar na promoção. Ignorado para o tipo de tema OFFER.
createTime

string (Timestamp format)

Apenas saída. Hora da criação da postagem.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Apenas saída. Hora da última modificação da postagem feita pelo usuário.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
scheduledTime

string (Timestamp format)

Se definido, determina quando uma postagem será publicada. Isso pode ser definido pelo usuário para programar postagens com antecedência.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
recurringInstanceTime
(deprecated)

string (Timestamp format)

Apenas saída. Descontinuado: use event.recurring_instance_time. Esse campo será removido em uma versão futura. Apenas saída. Hora em que a instância recorrente mais recente da postagem foi atualizada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
event

object (LocalPostEvent)

Informações do evento. Obrigatório para os tipos de tema EVENT e OFFER.
state

enum (LocalPostState)

Apenas saída. O estado da postagem, indicando em que parte do ciclo de vida ela está.
media[]

object (MediaItem)

A mídia associada à postagem. sourceUrl é o único campo de dados compatível com um MediaItem LocalPost.
searchUrl

string

Apenas saída. O link para a postagem local na Pesquisa Google. Esse link pode ser usado para compartilhar a postagem via rede social, e-mail, texto etc.
topicType

enum (LocalPostTopicType)

Obrigatório. O tipo de tópico da postagem: padrão, evento, oferta ou alerta.
alertType

enum (AlertType)

O tipo de alerta para o qual a postagem foi criada. Esse campo só é aplicável a postagens do tipo "Alerta" e funciona como um subtipo de alertas.
Campo de união topic_type_specific_fields. Campos específicos para um tipo de tópico. topic_type_specific_fields pode ser apenas de um dos tipos a seguir:
offer

object (LocalPostOffer)

Dados adicionais para postagens de oferta. Isso só deve ser definido quando o topicType for OFFER.

CallToAction

Uma ação realizada quando o usuário clica na postagem.

Representação JSON 
{
  "actionType": enum (ActionType),
  "url": string
}
Campos
actionType

enum (ActionType)

O tipo de ação que será realizada.
url

string

O URL ao qual o usuário será direcionado após um clique. Este campo precisa ser deixado sem definição para a CTA de chamada.

ActionType

O tipo de ação que será realizada.

Tipos enumerados
ACTION_TYPE_UNSPECIFIED Tipo não especificado.
BOOK Esta postagem pede que um usuário reserve um horário/mesa/etc.
ORDER Esta postagem pede que um usuário peça algo.
SHOP Esta postagem pede que um usuário navegue em um catálogo de produtos.
LEARN_MORE Esta postagem pede que um usuário saiba mais (no próprio site).
SIGN_UP Esta postagem pede que o usuário se registre, se inscreva ou participe.
GET_OFFER

Obsoleto. Use OFFER em LocalPostTopicType para criar uma postagem com conteúdo de oferta.
CALL Esta postagem pede que um usuário ligue para a empresa.

LocalPostEvent

Todas as informações relativas a um evento exibidas em uma postagem local.

Representação JSON 
{
  "title": string,
  "schedule": {
    object (TimeInterval)
  },
  "recurrenceInfo": {
    object (RecurrenceInfo)
  },
  "recurringInstanceTime": string
}
Campos
title

string

nome do evento.
schedule

object (TimeInterval)

Data/hora de início e término do evento.
recurrenceInfo

object (RecurrenceInfo)

Opcional. Armazena informações sobre a cadência de uma postagem recorrente. Só será definido se a postagem for recorrente.
recurringInstanceTime

string (Timestamp format)

Apenas saída. Hora em que a instância recorrente mais recente da postagem foi atualizada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

TimeInterval

Um intervalo de tempo inclusivo. Ele precisa conter todos os campos para ser válido.

Representação JSON 
{
  "startDate": {
    object (Date)
  },
  "startTime": {
    object (TimeOfDay)
  },
  "endDate": {
    object (Date)
  },
  "endTime": {
    object (TimeOfDay)
  }
}
Campos
startDate

object (Date)

A data de início deste período.
startTime

object (TimeOfDay)

O horário de início deste período.
endDate

object (Date)

A data de término deste período.
endTime

object (TimeOfDay)

O horário de término deste período.

Data

Representa uma data inteira ou parcial do calendário, como um aniversário. A hora do dia e o fuso horário são especificados em outro lugar ou são insignificantes. A data é referente ao calendário gregoriano. Isso pode representar uma das seguintes opções:

  • uma data completa, com valores de ano, mês e dia diferentes de zero;
  • um mês e dia, com um ano zero (por exemplo, uma data comemorativa);
  • um ano sozinho, com um mês zero e um dia zero;
  • um ano e mês, com um dia zero (por exemplo, uma data de validade de cartão de crédito).

Tipos relacionados:

Representação JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Ano da data. Precisa ser de 1 a 9.999 ou 0 para especificar uma data sem ano.
month

integer

Mês do ano. Precisa ser de 1 a 12, ou 0 para especificar um ano sem um mês e dia.
day

integer

Dia do mês. Precisa ser de 1 a 31 e válido para o ano e o mês, ou 0 para especificar um ano sozinho ou um ano e mês em que o dia não é significativo.

TimeOfDay

Representa um horário do dia. A data e o fuso horário não são relevantes ou são especificados em outro lugar. Uma API pode permitir segundos bissextos. Os tipos relacionados são google.type.Date e google.protobuf.Timestamp.

Representação JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Campos
hours

integer

Horas de um dia no formato de 24 horas. Precisa ser maior ou igual a 0 e geralmente menor ou igual a 23. Uma API pode permitir o valor "24:00:00" para o horário de fechamento da empresa, por exemplo.
minutes

integer

Minutos de uma hora. Precisa ser maior ou igual a 0 e menor ou igual a 59.
seconds

integer

Segundos de um minuto. Precisa ser maior ou igual a 0 e normalmente menor ou igual a 59. Uma API pode permitir o valor 60 se permitir segundos bissextos.
nanos

integer

Frações de segundos, em nanossegundos. Precisa ser maior ou igual a 0 e menor ou igual a 999.999.999.

RecurrenceInfo

Representa as informações de recorrência de uma postagem local.

Representação 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.
}
Campos
seriesEndTime

string (Timestamp format)

Opcional. O horário de término da série de recorrências.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
Campo de união occurrence_pattern. O padrão de ocorrência da postagem recorrente. occurrence_pattern pode ser apenas de um dos tipos a seguir:
dailyPattern

object (DailyOccurrencePattern)

Padrão de ocorrência diária.
weeklyPattern

object (WeeklyOccurrencePattern)

Padrão de ocorrência semanal.
monthlyPattern

object (MonthlyOccurrencePattern)

Padrão de ocorrência mensal.

DailyOccurrencePattern

Esse tipo não tem campos.

Representa um padrão de ocorrência diária.

WeeklyOccurrencePattern

Representa um padrão de recorrência semanal.

Representação JSON 
{
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
Campos
daysOfWeek[]

enum (DayOfWeek)

Opcional. A lista dos dias da semana para a oferta/evento. Se estiver vazio, a postagem será repetida no mesmo dia da semana que o schedule.start_time do evento.

DayOfWeek

Representa um dia da semana.

Enums
DAY_OF_WEEK_UNSPECIFIED O dia da semana não é especificado.
MONDAY Segunda-feira
TUESDAY Terça-feira
WEDNESDAY Quarta-feira
THURSDAY Quinta-feira
FRIDAY Sexta-feira
SATURDAY Sábado
SUNDAY Domingo

MonthlyOccurrencePattern

Representa um padrão de recorrência mensal.

Representação 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.
}
Campos
Campo de união monthly_option. A opção de recorrência para o padrão de ocorrência mensal. monthly_option pode ser apenas de um dos tipos a seguir:
dayOfMonth

integer

O dia do mês.

dayOfWeekOccurrence

enum (DayOfWeekOccurrence)

O dia da semana em que o evento ocorre no mês. O dia da semana é implícito pelo dia da semana do horário de início do evento. Por exemplo, se um evento começar em uma sexta-feira e dayOfWeekOccurrence for SECOND, o evento vai se repetir na segunda sexta-feira de cada mês.

DayOfWeekOccurrence

O dia da semana em que o evento ocorre no mês.

Tipos enumerados
DAY_OF_WEEK_OCCURRENCE_UNSPECIFIED Dia da semana não especificado.
FIRST Primeiro dia da semana no mês.
SECOND Segundo dia da semana no mês.
THIRD Terceiro dia da semana no mês.
FOURTH Quarto dia da semana no mês.
LAST Último dia da semana no mês.

LocalPostState

Indica o estado da postagem.

Tipos enumerados
LOCAL_POST_STATE_UNSPECIFIED Estado não especificado.
REJECTED Esta postagem foi rejeitada devido a uma violação da política de conteúdo.
LIVE Esta postagem foi publicada e está aparecendo nos resultados da pesquisa.
PROCESSING Esta postagem está sendo processada e não aparece nos resultados da pesquisa.
SCHEDULED Esta postagem está programada para o futuro e não aparece nos resultados da pesquisa.
RECURRING Esta postagem é recorrente e está aparecendo nos resultados da pesquisa.

LocalPostTopicType

O tipo de tópico da postagem local, que é usado para selecionar modelos diferentes e criar e renderizar uma postagem.

Tipos enumerados
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED Nenhum tipo de postagem foi especificado.
STANDARD A postagem contém informações básicas, como resumo e imagens.
EVENT A postagem contém informações básicas e um evento.
OFFER A postagem contém informações básicas, um evento e conteúdo relacionado a uma oferta (por exemplo, um código de cupom).
ALERT Anúncios de alta prioridade e oportunos relacionados a um evento em andamento. Esses tipos de postagens nem sempre estão disponíveis para criação.

AlertType

O tipo de evento para o qual a postagem de alerta foi criada.

Tipos enumerados
ALERT_TYPE_UNSPECIFIED Nenhum alerta especificado.
COVID_19 Alertas relacionados à pandemia do coronavírus de 2019. As postagens sobre a COVID-19 só aceitam um campo de resumo e um campo de call-to-action. Quando esses alertas não forem mais relevantes, a criação de novas postagens de alerta do tipo COVID-19 será desativada. No entanto, os comerciantes ainda poderão gerenciar as postagens sobre a COVID-19.

LocalPostOffer

Campos específicos para postagens de oferta.

Representação JSON 
{
  "couponCode": string,
  "redeemOnlineUrl": string,
  "termsConditions": string
}
Campos
couponCode

string

Opcional. Código da oferta utilizável na loja ou on-line.
redeemOnlineUrl

string

Opcional. Link on-line para resgatar a oferta.
termsConditions

string

Opcional. Termos e Condições da oferta.

Métodos

create

 Cria e retorna uma nova postagem local associada ao local especificado.

delete

 Exclui uma postagem local.

get

 Recebe a postagem local especificada.

list

 Retorna uma lista de postagens locais associadas a um local.

patch

 Atualiza a postagem local especificada e a retorna.