Entity feed

Definitions

EntityFeed Definition

message EntityFeed {
  repeated Entity data = 1;
}

Entity Definition

//
// Information about an Entity that is on the partner's platform. For example,
// an Entity could be a retail store, a hospital, an online business etc.
//
message Entity {
  // An opaque string generated by the partner that identifies an Entity.
  // Must be unique across all entities.
  // Strongly recommended to only include URL-safe characters. (required)
  string entity_id = 1;

  // If present, the name, telephone, url and location are used to support
  // matching partner inventory with entities already present on Google. This
  // information will not be displayed.

  // The name of the Entity. (required)
  string name = 2;

  // The contact telephone number of the Entity including its country and area
  // codes, e.g. +14567891234. Highly recommended. (optional)
  string telephone = 3;

  // The url of the Entity's public website. Highly recommended. (optional)
  string url = 4;

  // The location of the Entity (required)
  madden.ingestion.GeoCoordinates location = 5;
}

GeoCoordinates Definition

// The Geo data of a location, including latitude, longitude, and address.
// At least one of [lat/lng or address] should be provided (or both).
message GeoCoordinates {
  double latitude = 1;   // In degrees. (optional)
  double longitude = 2;  // In degrees. (optional)

  // Address for a location, could either be structured or unstructured.
  oneof addresses {
    // Postal address of the location, preferred.
    PostalAddress address = 3;
    // An unstructured address could also be provided as a fallback.
    // E.g. "1600 amphitheatre parkway mountain view, ca 94043"
    string unstructured_address = 4;
  }
}

PostalAddress Definition

// The postal address for a merchant.
message PostalAddress {
  // The country, using ISO 3166-1 alpha-2 country code, e.g. "US" (required)
  string country = 1;
  // The locality/city, e.g. "Mountain View". (required)
  string locality = 2;
  // The region/state/province, e.g. "CA". This field is only required in
  // countries where region is commonly a part of the address. (optional)
  string region = 3;
  // The postal code, e.g. "94043". (required)
  string postal_code = 4;
  // The street address, e.g. "1600 Amphitheatre Pkwy". (required)
  string street_address = 5;
}

Entity feeds samples

Entity Feed

{
  "data": [
    {
      "entity_id": "appointments-merchant-1",
      "name": "Lorem ipsum Barbershop",
      "telephone": "+11111222233",
      "url": "https://barbershop.com",
      "location": {
        "latitude": 37.422113,
        "longitude": -122.084041,
        "address": {
          "country": "US",
          "locality": "Mountain View",
          "region": "California",
          "postal_code": "94043",
          "street_address": "1600 Amphitheater Drive"
        }
      }
    }
  ]
}

Descriptor File

{
  "generation_timestamp": 1677545962,
  "name": "reservewithgoogle.entity",
  "data_file": [
    "entity_1677545962.json"
  ]
}