פיד כרטיסי מתנה

מוכרים יוכלו להוסיף קישורים לרכישת כרטיסי מתנה לדף העסקי שלהם ב-Google. הפיד של כרטיסי המתנה משמש לפלטפורמת כרטיסי המתנה כדי לשלוח מדדים לגבי תוצאות הימים הקודמים לגבי כל כרטיסי המתנה. בפיד של כרטיסי המתנה ייעשה שימוש בחשבון התיקייה הכללית עם הערך 'name' בקובץ התיאור, כאשר הערך שלו הוא 'fundround.giftcard'. להסבר על השימוש בתיקייה גנרית, עיינו במדריך הזה. המפרט של פרוטו זמין בהמשך כמו גם פיד JSON לדוגמה.

הערה: הסעיף הזה רלוונטי רק לשותפים שמשלימים שילוב של גיוס כספים לעסקים קטנים. אם אתם לא בטוחים שאתם משתתפים בפרויקט הזה, פנו לאיש הקשר שלכם ב-Google לפיתוח עסקי.

מפרט אב

המפרט בהמשך זמין בפורמט אב. אפשרות זו משמשת להגדרת כל השדות שזמינים בפיד. כשמעלים לתיקייה גנרית, אפשר גם להשתמש בפורמט JSON כמו שמוצג בדוגמת ה-JSON.

הגדרת פיד של כרטיסי מתנה

message GiftCardFeed {
  repeated GiftCard data = 1;
}

הגדרת כרטיס מתנה

message GiftCard {
  // Unique identifier for the gift card. (required)
  // (Note: could be the same as the gift card url if that's the only unique
  // identifier the partner uses. This will mainly be used for identification
  // when Google and partners communicate issues for a particular gift card
  // entry.)
  string gift_card_id = 1;

  // Whether this gift card entry is active (i.e. able to be purchased) or
  // inactive. (required)
  GiftCardStatus gift_card_status = 2;

  // The gift card url on the platform. (required)
  string gift_card_url = 3;

  // The date in YYYY-MM-DD format indicates when the
  // amount_contributed_previous_day and num_of_transactions_previous_day data
  // below are retrieved. Should always be one day after the date which the
  // stats in xxx_previous_day corresponds to. UTC timezone should be used to
  // delineate which transactions fall on which dates.
  //  E.g. if the amount_contributed_previous_day corresponds to the amount
  //  contributed yesterday, then the data_retrieval_date here should be set as
  //  today's date. (required)
  // The feed must include all gift card entries for the given date (no partial
  // uploads). (required)
  string data_retrieval_date = 4;

  // Previous day's monetary amount contributed through the Enhanced User
  // Referral Feature(s) to this gift card program. (required)
  MonetaryAmount amount_contributed_previous_day = 5;

  // Previous day's number of transactions through the Enhanced User Referral
  // Feature(s) for this gift card program. (required)
  int32 num_transactions_previous_day = 6;

  // Information about the merchant that initiated the campaign. (required)
  MerchantInfo merchant_info = 7;
}

הגדרת הסטטוס של כרטיס המתנה

message GiftCardStatus {
  enum Status {
    // Unused.
    STATUS_UNSPECIFIED = 0;

    // Able to be purchased.
    ACTIVE = 1;

    // Unable to be purchased.
    INACTIVE = 2;
  }
  Status status = 1;
}

הגדרת המוכר

message MerchantInfo {
  // Unique identifier for the merchant.
  // (recommended for Campaign feed, required for others)
  string merchant_id = 1;

  // Name of the merchant that initiated the campaign.
  // (recommended for Campaign feed, required for others)
  string merchant_name = 2;

  // Unstructured address of the merchant that initiated the gift card.
  // (optional)
  // E.g. "1600 Amphitheatre Pkwy, Mountain View, CA, USA, 94043"
  string merchant_address_unstructured = 3;

  // Structured address of the merchant that initiated the gift card. (required)
  PostalAddress merchant_postal_address = 4;

  // Business category of the merchant, e.g. restaurant. (optional)
  // See https://developers.google.com/places/supported_types for possible
  // categories.
  string merchant_category = 5;
}

הגדרת סכום כספי

message MonetaryAmount {
  // The monetary amount in centi-units of the currency.
  // For example: 1.95 USD is 195 in centi-units.
  // If your amount contains fractions of the smallest currency unit, then it
  // will be rounded using nearest even rounding (e.g. 2.5 cents rounded
  // to 2 cents, 3.5 cents rounded to 4 cents, 0.5 cents rounded to 0 cents,
  // 2.51 cents rounded to 3 cents). (required)
  int64 monetary_amount_centi = 1;

  // The currency of the price that is defined in ISO 4217. (required)
  string currency_code = 2;
}

הגדרת כתובת למשלוח דואר

// The postal address for a merchant.
message PostalAddress {
  // The country, 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". (optional)
  string street_address = 5;
}

דוגמה לכרטיס מתנה (בפורמט JSON)

קטע ה-JSON בדוגמה הבאה כולל כרטיס מתנה פעיל אחד שזמין למכירה עבור Jetters Pizza. ביום הקודם בוצעו שתי מכירות של כרטיסי מתנה, בסכום כולל של 50.00 $במכירות ממשתמשי Google. בנוסף לקובץ הזה, צריך להעלות גם קובץ תיאור לתיקייה גנרית בענן, שבה הערך 'name' בקובץ התיאור מוגדר ל-'fundround.giftcard'. במדריך הזה מוסבר איך משתמשים בקובץ עזר כללי של תיקייה בענן.

{
  "data": [
    {
      "gift_card_id": "1",
      "gift_card_status": {
        "status": "ACTIVE"
      },
      "gift_card_url": "www.example.com/jetterspizza",
      "data_retrieval_date": "2020-04-24",
      "amount_contributed_previous_day": {
        "monetary_amount_centi": 5000,
        "currency_code": "USD"
      },
      "num_of_transactions_previous_day": 2,
      "merchant_info": {
        "merchant_id": "A",
        "merchant_name": "Jetters Pizza",
        "merchant_address_unstructured": "1600 Amphitheatre Pkwy, Mountain View, CA, USA, 94043",
        "merchant_postal_address": {
          "country": "United States",
          "region": "CA",
          "postal_code": "94043",
          "street_address": "1600 Amphitheatre Pkwy",
          "locality": "Mountain View"
        },
        "merchant_category": "restaurant"
      }
    }
  ]
}