REST Resource: accounts.locations.localPosts

Ressource : LocalPost

Représente un post local pour un établissement.

Représentation 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.
}
Champs
name

string

Uniquement en sortie. Identifiant Google de ce post local, sous la forme accounts/{accountId}/locations/{locationId}/localPosts/{local_post_id}
languageCode

string

Langue du post local.
summary

string

Description/corps du post local.
callToAction

object (CallToAction)

URL vers laquelle les utilisateurs sont redirigés lorsqu'ils cliquent sur la promotion. Ignoré pour le type de thème OFFER.
createTime

string (Timestamp format)

Uniquement en sortie. Date et heure de création du post.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. Heure de la dernière modification du post publié par l'utilisateur.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
scheduledTime

string (Timestamp format)

Si cette option est définie, elle détermine la date de publication d'un post. L'utilisateur peut définir ce paramètre pour programmer des posts à l'avance.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
recurringInstanceTime
(deprecated)

string (Timestamp format)

Uniquement en sortie. Obsolète : utilisez plutôt event.recurring_instance_time. Ce champ sera supprimé dans une prochaine version. Uniquement en sortie. Heure à laquelle l'instance récurrente la plus récente du post a été mise à jour.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
event

object (LocalPostEvent)

Informations sur l'événement. Obligatoire pour les types de thèmes EVENT et OFFER.
state

enum (LocalPostState)

Uniquement en sortie. État du post, indiquant la phase de son cycle de vie.
media[]

object (MediaItem)

Contenu multimédia associé au post. sourceUrl est le seul champ de données accepté pour un élément MediaItem LocalPost.
searchUrl

string

Uniquement en sortie. Lien vers le post local dans la recherche Google. Ce lien peut être utilisé pour partager le post sur les réseaux sociaux, par e-mail, par SMS, etc.
topicType

enum (LocalPostTopicType)

Obligatoire. Type de sujet du post : standard, événement, offre ou alerte.
alertType

enum (AlertType)

Type d'alerte pour lequel le post est créé. Ce champ ne concerne que les posts de type topicType Alert et se comporte comme un sous-type d'alertes.
Champ d'union topic_type_specific_fields. Champs spécifiques pour un type de sujet. topic_type_specific_fields ne peut être qu'un des éléments suivants :
offer

object (LocalPostOffer)

Données supplémentaires pour les posts d'offres. Ce champ ne doit être défini que lorsque topicType est défini sur OFFER.

CallToAction

Action effectuée lorsque l'utilisateur clique sur le post.

Représentation JSON 
{
  "actionType": enum (ActionType),
  "url": string
}
Champs
actionType

enum (ActionType)

Type d'action qui sera effectuée.
url

string

URL vers laquelle l'utilisateur est dirigé lorsqu'il clique sur le post. Ce champ ne doit pas être défini pour l'incitation à l'action "Appeler".

ActionType

Type d'action qui sera effectuée.

Enums
ACTION_TYPE_UNSPECIFIED Type non spécifié
BOOK Ce post propose à l'utilisateur de réserver un rendez-vous, une table, etc.
ORDER Ce post propose à l'utilisateur de commander quelque chose.
SHOP Ce post propose à l'utilisateur de parcourir un catalogue de produits.
LEARN_MORE Ce post propose à l'utilisateur d'en savoir plus (sur le site Web).
SIGN_UP Ce post propose à l'utilisateur de s'inscrire ou de participer.
GET_OFFER

Obsolète. Utilisez OFFER dans LocalPostTopicType pour créer un post avec du contenu d'offre.
CALL Ce post propose à l'utilisateur d'appeler l'établissement.

LocalPostEvent

Toutes les informations concernant un événement présenté dans un post local.

Représentation JSON 
{
  "title": string,
  "schedule": {
    object (TimeInterval)
  },
  "recurrenceInfo": {
    object (RecurrenceInfo)
  },
  "recurringInstanceTime": string
}
Champs
title

string

Nom de l'événement.
schedule

object (TimeInterval)

Dates et heures de début et de fin de l'événement.
recurrenceInfo

object (RecurrenceInfo)

Facultatif. Stocke des informations sur la fréquence d'un post récurrent. Ne sera défini que si le post est récurrent.
recurringInstanceTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle l'instance récurrente la plus récente du post a été mise à jour.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

TimeInterval

Intervalle de temps inclusif. Pour qu'il soit valide, il doit contenir tous les champs.

Représentation JSON 
{
  "startDate": {
    object (Date)
  },
  "startTime": {
    object (TimeOfDay)
  },
  "endDate": {
    object (Date)
  },
  "endTime": {
    object (TimeOfDay)
  }
}
Champs
startDate

object (Date)

Date de début de cette période.
startTime

object (TimeOfDay)

Heure de début de cette période.
endDate

object (Date)

Date de fin de cette période.
endTime

object (TimeOfDay)

Heure de fin de cette période.

Date

Représente une date du calendrier entière ou partielle, par exemple un anniversaire. L'heure de la journée et le fuseau horaire sont spécifiés ailleurs, ou ne sont pas significatifs. La date correspond au calendrier grégorien proleptique. Il peut s'agir de l'un des éléments suivants :

  • Une date complète, avec des valeurs non nulles pour l'année, le mois et le jour.
  • Un mois et un jour, avec une année nulle (par exemple, un anniversaire).
  • Une année seule, avec un mois et un jour nuls.
  • Une année et un mois, avec un jour zéro (par exemple, la date d'expiration d'une carte de crédit).

Types associés :

Représentation JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Champs
year

integer

Année de la date. Elle doit être comprise entre 1 et 9 999, ou égale à 0 si vous spécifiez une date sans année.
month

integer

Mois d'une année. Il doit être compris entre 1 et 12, ou égal à 0 si vous spécifiez une année sans mois ni jour.
day

integer

Jour du mois. Il doit être compris entre 1 et 31, et valide pour l'année et le mois, ou égal à 0 si vous spécifiez une année seule, ou une année et un mois où le jour n'est pas significatif.

TimeOfDay

Représente une heure de la journée. La date et le fuseau horaire sont spécifiés ailleurs, ou ne sont pas significatifs. Une API peut choisir d'autoriser des secondes intercalaires. Les types associés sont google.type.Date et google.protobuf.Timestamp.

Représentation JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Champs
hours

integer

Heures de la journée au format 24 heures. Doit être supérieur ou égal à 0 et généralement inférieur ou égal à 23. Une API peut choisir d'autoriser la valeur "24:00:00" pour des cas tels que l'heure de fermeture des bureaux.
minutes

integer

Minutes d'une heure. Doit être supérieur ou égal à 0 et inférieur ou égal à 59.
seconds

integer

Secondes d'une minute. Doit être supérieur ou égal à 0 et généralement inférieur ou égal à 59. Une API peut autoriser la valeur 60 si elle autorise les secondes intercalaires.
nanos

integer

Fractions de secondes, en nanosecondes. La valeur doit être supérieure ou égale à 0 et inférieure ou égale à 999 999 999.

RecurrenceInfo

Représente les informations de récurrence d'un post local.

Représentation 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.
}
Champs
seriesEndTime

string (Timestamp format)

Facultatif. Heure de fin de la série de récurrences.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
Champ d'union occurrence_pattern. Modèle d'occurrence du post récurrent. occurrence_pattern ne peut être qu'un des éléments suivants :
dailyPattern

object (DailyOccurrencePattern)

Schéma d'occurrence quotidienne.
weeklyPattern

object (WeeklyOccurrencePattern)

Schéma d'occurrence hebdomadaire.
monthlyPattern

object (MonthlyOccurrencePattern)

Schéma d'occurrence mensuel.

DailyOccurrencePattern

Ce type ne comporte aucun champ.

Représente un modèle d'occurrence quotidienne.

WeeklyOccurrencePattern

Représente un modèle d'occurrence hebdomadaire.

Représentation JSON 
{
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
Champs
daysOfWeek[]

enum (DayOfWeek)

Facultatif. Liste des jours de la semaine pour l'offre/l'événement. Si ce champ est vide, le post sera répété le même jour de la semaine que schedule.start_time de l'événement.

DayOfWeek

Représente un jour de la semaine.

Enums
DAY_OF_WEEK_UNSPECIFIED Le jour de la semaine n'est pas spécifié.
MONDAY Lundi
TUESDAY Mardi
WEDNESDAY Mercredi
THURSDAY Jeudi
FRIDAY Vendredi
SATURDAY Samedi
SUNDAY Dimanche

MonthlyOccurrencePattern

Représente un modèle d'occurrence mensuel.

Représentation 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.
}
Champs
Champ d'union monthly_option. Option de récurrence pour le modèle d'occurrence mensuel. monthly_option ne peut être qu'un des éléments suivants :
dayOfMonth

integer

Jour du mois.
dayOfWeekOccurrence

enum (DayOfWeekOccurrence)

Occurrence du jour de la semaine dans le mois. Le jour de la semaine est implicite et correspond à celui de l'heure de début de l'événement. Par exemple, si un événement commence un vendredi et que dayOfWeekOccurrence est défini sur SECOND, l'événement se répète le deuxième vendredi de chaque mois.

DayOfWeekOccurrence

Occurrence du jour de la semaine dans le mois.

Enums
DAY_OF_WEEK_OCCURRENCE_UNSPECIFIED Occurrence d'un jour de la semaine non spécifié.
FIRST Premier jour de la semaine du mois.
SECOND Deuxième jour de la semaine du mois.
THIRD Troisième jour de la semaine du mois.
FOURTH Quatrième jour de la semaine du mois.
LAST Dernier jour de la semaine du mois.

LocalPostState

Indique l'état du post.

Enums
LOCAL_POST_STATE_UNSPECIFIED État non spécifié.
REJECTED Ce post a été refusé, car il ne respecte pas le règlement relatif au contenu.
LIVE Ce post est publié et apparaît actuellement dans les résultats de recherche.
PROCESSING Ce post est en cours de traitement et n'apparaît pas dans les résultats de recherche.
SCHEDULED Ce post est programmé pour une date ultérieure et n'apparaît pas dans les résultats de recherche.
RECURRING Ce post est récurrent et apparaît actuellement dans les résultats de recherche.

LocalPostTopicType

Type de sujet du post local, qui permet de sélectionner différents modèles pour créer et afficher un post.

Enums
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED Aucun type de post n'est spécifié.
STANDARD Le post comporte des informations de base, telles qu'un résumé et des images.
EVENT Le post comporte des informations de base et un événement.
OFFER Le post comporte des informations de base, un événement et du contenu lié à l'offre (par exemple, un code promotionnel).
ALERT Annonces ponctuelles hautement prioritaires concernant un événement en cours. Il n'est pas toujours possible de créer ces types de posts.

AlertType

Type d'événement pour lequel le post d'alerte a été créé.

Enums
ALERT_TYPE_UNSPECIFIED Aucune alerte n'est spécifiée.
COVID_19 Alertes liées à la pandémie de maladie à coronavirus 2019. Les posts sur le COVID n'acceptent qu'un champ de résumé et un champ d'incitation à l'action. Lorsque ces alertes ne seront plus pertinentes, la création de posts d'alerte de type "COVID-19" sera désactivée. Toutefois, les marchands pourront toujours gérer leurs posts existants sur la COVID-19.

LocalPostOffer

Champs spécifiques pour les posts d'offres.

Représentation JSON 
{
  "couponCode": string,
  "redeemOnlineUrl": string,
  "termsConditions": string
}
Champs
couponCode

string

Facultatif. Code promotionnel utilisable en magasin ou en ligne.
redeemOnlineUrl

string

Facultatif. Lien en ligne pour bénéficier de l'offre.
termsConditions

string

Facultatif. Conditions d'utilisation de l'offre.

Méthodes

create

 Crée un post local associé à l'établissement spécifié, puis l'affiche.

delete

 Supprime un post local.

get

 Récupère le post local spécifié.

list

 Renvoie la liste des posts locaux associés à un établissement.

patch

 Met à jour le post local spécifié et le renvoie.