تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

تعديل فئات البطاقات وعناصر البطاقات

إنّ إبقاء البطاقات محدّثة هو وسيلة مهمة للتفاعل مع العملاء وتقديم تجربة إيجابية.

هناك مرجعان يمكن تعديلهما: TransitClass وTransitObject.

أفضل الممارسات

تحتوي القائمة التالية على معلومات مفيدة يجب مراعاتها عند تعديل فئات بطاقات النقل العام وعناصرها:

عندما تريد تعديل فئة أو عنصر بالكامل، يمكنك إرسال طلب update. عندما تريد تعديل عدد صغير من الحقول في فئة أو عنصر، أرسِل طلب patch.
عند تقديم طلب "update"، يتم تعديل العنصر أو الفئة بالكامل. وهذا يعني أنّه سيتم محو أي حقول غير مضمّنة في الطلب. قبل إرسال طلب update، ننصحك بإرسال طلب GET للتأكد من أنك تعمل على أحدث إصدار ومن تضمين جميع الحقول المطلوبة في طلبك.
عند تقديم طلب "patch"، يتم تحديث الحقول المصحّحة فقط. قبل إرسال طلب patch، يمكنك بشكل اختياري إرسال طلب GET لمقارنة التغييرات التي أجريتها بأحدث نسخة.
عند إرسال طلبات patch لتعديل الصفائف، يتم استبدال الصفيف الأصلي بالمصفوفة المضمّنة في نص الطلب. لا يمكنك تعديل العناصر في صفيف بشكل فردي.
في بعض الحالات، قد لا تعرف وقت حدوث التغييرات أو وقت بدء التحديثات. ننصحك بجدولة طلبات update أو patch بشكل دوري لكل الفئات والكائنات.

تعديل فئة البطاقات

استخدام Google Wallet Business Console

يمكن تعديل فئات البطاقات (وليس العناصر) مباشرةً في Google Pay & Wallet Console.

الانتقال إلى وحدة التحكّم
اختَر 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}

لمزيد من المعلومات، يُرجى الاطّلاع على مرجع واجهة برمجة التطبيقات.

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}