דף זה תורגם על ידי Cloud Translation API.

עדכון אובייקטים של מחלקות ואישורים של כרטיסים

עדכון כרטיסים הוא דרך חשובה ליצירת קשר עם הלקוחות וליצירת חוויה חיובית.

יש שני משאבים שאפשר לעדכן: TransitClass וה-TransitObject.

שיטות מומלצות

הרשימה הבאה מכילה מידע שימושי שכדאי לזכור כשמעדכנים את המחלקות והאובייקטים של כרטיסי התחבורה הציבורית:

כדי לעדכן מחלקה או אובייקט שלמים, צריך לשלוח בקשת update. כדי לעדכן מספר קטן של שדות במחלקה או באובייקט, צריך לשלוח בקשה patch.
כששולחים בקשת update, האובייקט או המחלקה כולו מעודכנים. המשמעות היא שכל השדות שלא נכללים בבקשה יימחקו. לפני ששולחים בקשת update, מומלץ לשלוח בקשת GET כדי לוודא שאתם עובדים עם הגרסה האחרונה ושכל השדות המיועדים כלולים בבקשה.
כששולחים בקשת patch, רק השדות המתוקנים מתעדכנים. לפני ששולחים בקשת patch, כדאי לשלוח בקשה GET כדי להשוות בין השינויים לגרסה האחרונה.
כששולחים בקשות patch לעדכון מערכים, המערך המקורי מוחלף בזה שנכלל בגוף הבקשה. אי אפשר לשנות את הרכיבים במערך בנפרד.
במקרים מסוימים, יכול להיות שלא תדעו מתי מתרחשים שינויים או מתי להפעיל עדכונים. כדאי לתזמן מדי פעם בקשות של update או patch לכל הכיתות והאובייקטים.

עדכון מחלקה של כרטיסים

השתמש במסוף העסקי של Google Wallet

אפשר לשנות מחלקות של כרטיסים (ולא אובייקטים) ישירות במסוף של Google Pay ו-Wallet.

ניווט אל המסוף
בוחרים באפשרות Google Wallet API.
בחירת הכיתה שרוצים לשנות
בוחרים באפשרות עריכה.
עדכון מאפייני הכיתה
לוחצים על שמירה.

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

שימוש ב-Google Wallet API

עדכון של TransitClass משפיע על כל המשתמשים שהוקצו להם כרטיסי תחבורה ציבורית באמצעות המחלקה הזו. לדוגמה, כדי לעדכן את הלוגו של הכרטיסים לתחבורה הציבורית, צריך לשלוח בקשה update או patch ל-Google Wallet API בכל אחת מנקודות הקצה הבאות. הערך resourceId יהיה מזהה המחלקה (ISSUER_ID.CLASS_SUFFIX).

# Update
PUT https://walletobjects.googleapis.com/walletobjects/v1/transitclass/{resourceId}

# Patch
PATCH https://walletobjects.googleapis.com/walletobjects/v1/transitclass/{resourceId}

למידע נוסף, קראו את הפניית API.

Java

כדי להתחיל בשילוב ב-Java, עיינו ב דוגמאות הקוד המלאות ב-GitHub.

/**
 * Update a class.
 *
 * <p><strong>Warning:</strong> This replaces all existing class attributes!
 *
 * @param issuerId The issuer ID being used for this request.
 * @param classSuffix Developer-defined unique ID for this pass class.
 * @return The pass class ID: "{issuerId}.{classSuffix}"
 */
public String updateClass(String issuerId, String classSuffix) throws IOException {
  TransitClass updatedClass;

  // Check if the class exists
  try {
    updatedClass =
        service.transitclass().get(String.format("%s.%s", issuerId, classSuffix)).execute();
  } catch (GoogleJsonResponseException ex) {
    if (ex.getStatusCode() == 404) {
      // Class does not exist
      System.out.printf("Class %s.%s not found!%n", issuerId, classSuffix);
      return String.format("%s.%s", issuerId, classSuffix);
    } else {
      // Something else went wrong...
      ex.printStackTrace();
      return String.format("%s.%s", issuerId, classSuffix);
    }
  }

  // Class exists
  // Update the class by adding a homepage
  updatedClass.setHomepageUri(
      new Uri()
          .setUri("https://developers.google.com/wallet")
          .setDescription("Homepage description"));

  // Note: reviewStatus must be 'UNDER_REVIEW' or 'DRAFT' for updates
  updatedClass.setReviewStatus("UNDER_REVIEW");

  TransitClass response =
      service
          .transitclass()
          .update(String.format("%s.%s", issuerId, classSuffix), updatedClass)
          .execute();

  System.out.println("Class update response");
  System.out.println(response.toPrettyString());

  return response.getId();
}

PHP

כדי להתחיל בשילוב ב-PHP, עיינו ב דוגמאות הקוד המלאות ב-GitHub.

/**
 * Update a class.
 *
 * **Warning:** This replaces all existing class attributes!
 *
 * @param string $issuerId The issuer ID being used for this request.
 * @param string $classSuffix Developer-defined unique ID for this pass class.
 *
 * @return string The pass class ID: "{$issuerId}.{$classSuffix}"
 */
public function updateClass(string $issuerId, string $classSuffix)
{
  // Check if the class exists
  try {
    $updatedClass = $this->service->transitclass->get("{$issuerId}.{$classSuffix}");
  } catch (Google\Service\Exception $ex) {
    if (!empty($ex->getErrors()) && $ex->getErrors()[0]['reason'] == 'classNotFound') {
      // Class does not exist
      print("Class {$issuerId}.{$classSuffix} not found!");
      return "{$issuerId}.{$classSuffix}";
    } else {
      // Something else went wrong...
      print_r($ex);
      return "{$issuerId}.{$classSuffix}";
    }
  }

  // Update the class by adding a homepage
  $updatedClass->setHomepageUri(new Uri([
    'uri' => 'https://developers.google.com/wallet',
    'description' => 'Homepage description'
  ]));

  // Note: reviewStatus must be 'UNDER_REVIEW' or 'DRAFT' for updates
  $updatedClass->setReviewStatus('UNDER_REVIEW');

  $response = $this->service->transitclass->update("{$issuerId}.{$classSuffix}", $updatedClass);

  print "Class update response\n";
  print_r($response);

  return $response->id;
}

Python

כדי להתחיל בשילוב עם Python, עיינו ב דוגמאות הקוד המלאות ב-GitHub.

def update_class(self, issuer_id: str, class_suffix: str) -> str:
    """Update a class.

    **Warning:** This replaces all existing class attributes!

    Args:
        issuer_id (str): The issuer ID being used for this request.
        class_suffix (str): Developer-defined unique ID for this pass class.

    Returns:
        The pass class ID: f"{issuer_id}.{class_suffix}"
    """

    # Check if the class exists
    try:
        response = self.client.transitclass().get(resourceId=f'{issuer_id}.{class_suffix}').execute()
    except HttpError as e:
        if e.status_code == 404:
            print(f'Class {issuer_id}.{class_suffix} not found!')
            return f'{issuer_id}.{class_suffix}'
        else:
            # Something else went wrong...
            print(e.error_details)
            return f'{issuer_id}.{class_suffix}'

    # Class exists
    updated_class = response

    # Update the class by adding a homepage
    updated_class['homepageUri'] = {
        'uri': 'https://developers.google.com/wallet',
        'description': 'Homepage description'
    }

    # Note: reviewStatus must be 'UNDER_REVIEW' or 'DRAFT' for updates
    updated_class['reviewStatus'] = 'UNDER_REVIEW'

    response = self.client.transitclass().update(
        resourceId=f'{issuer_id}.{class_suffix}',
        body=updated_class).execute()

    print('Class update response')
    print(response)

    return f'{issuer_id}.{class_suffix}'

C#

כדי להתחיל את השילוב ב-C#, עיינו ב דוגמאות הקוד המלאות ב-GitHub.

/// <summary>
/// Update a class.
/// <para />
/// <strong>Warning:</strong> This replaces all existing class attributes!
/// </summary>
/// <param name="issuerId">The issuer ID being used for this request.</param>
/// <param name="classSuffix">Developer-defined unique ID for this pass class.</param>
/// <returns>The pass class ID: "{issuerId}.{classSuffix}"</returns>
public string UpdateClass(string issuerId, string classSuffix)
{
  // Check if the class exists
  Stream responseStream = service.Transitclass
      .Get($"{issuerId}.{classSuffix}")
      .ExecuteAsStream();

  StreamReader responseReader = new StreamReader(responseStream);
  JObject jsonResponse = JObject.Parse(responseReader.ReadToEnd());

  if (jsonResponse.ContainsKey("error"))
  {
    if (jsonResponse["error"].Value<int>("code") == 404)
    {
      // Class does not exist
      Console.WriteLine($"Class {issuerId}.{classSuffix} not found!");
      return $"{issuerId}.{classSuffix}";
    }
    else
    {
      // Something else went wrong...
      Console.WriteLine(jsonResponse.ToString());
      return $"{issuerId}.{classSuffix}";
    }
  }

  // Class exists
  TransitClass updatedClass = JsonConvert.DeserializeObject<TransitClass>(jsonResponse.ToString());

  // Update the class by adding a homepage
  updatedClass.HomepageUri = new Google.Apis.Walletobjects.v1.Data.Uri
  {
    UriValue = "https://developers.google.com/wallet",
    Description = "Homepage description"
  };

  // Note: reviewStatus must be 'UNDER_REVIEW' or 'DRAFT' for updates
  updatedClass.ReviewStatus = "UNDER_REVIEW";

  responseStream = service.Transitclass
      .Update(updatedClass, $"{issuerId}.{classSuffix}")
      .ExecuteAsStream();

  responseReader = new StreamReader(responseStream);
  jsonResponse = JObject.Parse(responseReader.ReadToEnd());

  Console.WriteLine("Class update response");
  Console.WriteLine(jsonResponse.ToString());

  return $"{issuerId}.{classSuffix}";
}

Node.js

כדי להתחיל את השילוב ב-Node, אפשר לעיין ב דוגמאות הקוד המלאות ב-GitHub.

/**
 * Update a class.
 *
 * **Warning:** This replaces all existing class attributes!
 *
 * @param {string} issuerId The issuer ID being used for this request.
 * @param {string} classSuffix Developer-defined unique ID for this pass class.
 *
 * @returns {string} The pass class ID: `${issuerId}.${classSuffix}`
 */
async updateClass(issuerId, classSuffix) {
  let response;

  // Check if the class exists
  try {
    response = await this.client.transitclass.get({
      resourceId: `${issuerId}.${classSuffix}`
    });
  } catch (err) {
    if (err.response && err.response.status === 404) {
      console.log(`Class ${issuerId}.${classSuffix} not found!`);
      return `${issuerId}.${classSuffix}`;
    } else {
      // Something else went wrong...
      console.log(err);
      return `${issuerId}.${classSuffix}`;
    }
  }

  // Class exists
  let updatedClass = response.data;

  // Update the class by adding a homepage
  updatedClass['homepageUri'] = {
    'uri': 'https://developers.google.com/wallet',
    'description': 'Homepage description'
  };

  // Note: reviewStatus must be 'UNDER_REVIEW' or 'DRAFT' for updates
  updatedClass['reviewStatus'] = 'UNDER_REVIEW';

  response = await this.client.transitclass.update({
    resourceId: `${issuerId}.${classSuffix}`,
    requestBody: updatedClass
  });

  console.log('Class update response');
  console.log(response);

  return `${issuerId}.${classSuffix}`;
}

עדכון אובייקט של כרטיסים

עדכון של TransitObject בודד משפיע רק על המשתמש שהוקצה לו האובייקט הספציפי הזה. חשוב לעדכן באופן קבוע כרטיסי נסיעה נפרדים כדי לשקף את השינויים שמשפיעים על הלקוחות שלכם ולעודד אותם להמשיך להיות מעורבים. הערך resourceId יהיה מזהה האובייקט (ISSUER_ID.OBJECT_SUFFIX).

# Update
PUT https://walletobjects.googleapis.com/walletobjects/v1/transitobject/{resourceId}

# Patch
PATCH https://walletobjects.googleapis.com/walletobjects/v1/transitobject/{resourceId}