REST Resource: accounts.programs

المرجع: برنامج

يشير إلى المشاركة في برنامج معيّن للحساب المحدّد.

توفّر البرامج آلية لإضافة وظائف إلى حسابات التجّار. وخير مثال على ذلك برنامج بيانات المنتج المجانية الذي يتيح عرض منتجات من متجر التاجر مجانًا على Google.

تمثيل JSON
{
  "name": string,
  "documentationUri": string,
  "state": enum (State),
  "activeRegionCodes": [
    string
  ],
  "unmetRequirements": [
    {
      object (Requirement)
    }
  ]
}
الحقول
name

string

المُعرّف. اسم مورد البرنامج. تنسيق الملف: accounts/{account}/programs/{program}

documentationUri

string

النتائج فقط. عنوان URL لصفحة مساعدة في Merchant Center تصف البرنامج.

state

enum (State)

النتائج فقط. حالة المشاركة للحساب في البرنامج.

activeRegionCodes[]

string

النتائج فقط. المناطق التي يشارك فيها الحساب بشكل نشط في البرنامج. وتُعرف المناطق النشِطة بأنها تلك المناطق التي تم فيها استيفاء جميع متطلبات البرنامج في المناطق النشِطة.

يتم تحديد رموز المناطق من خلال CLDR. يجب أن يكون هذا البلد أحد البلدان التي يسري فيها البرنامج تحديدًا في هذا البلد أو 001 عندما يُطبَّق البرنامج في جميع أنحاء العالم.

unmetRequirements[]

object (Requirement)

النتائج فقط. المتطلبات التي لم يستوفِها الحساب حتى الآن والتي تؤثر في المشاركة في البرنامج.

الحالة

حالات المشاركة المحتملة في البرنامج للحساب

عمليات التعداد
STATE_UNSPECIFIED القيمة التلقائية. هذه القيمة غير مستخدمة.
NOT_ELIGIBLE الحساب غير مؤهّل للمشاركة في البرنامج.
ELIGIBLE أن يكون الحساب مؤهلاً للمشاركة في البرنامج.
ENABLED تمّ تفعيل البرنامج للحساب.

المطلوب للحصول على الشارة

يحدد متطلبات محددة للمشاركة في البرنامج.

تمثيل JSON
{
  "title": string,
  "documentationUri": string,
  "affectedRegionCodes": [
    string
  ]
}
الحقول
title

string

النتائج فقط. اسم الشرط

documentationUri

string

النتائج فقط. عنوان URL لصفحة مساعدة تصف المتطلبات.

affectedRegionCodes[]

string

النتائج فقط. لا يتم استيفاء هذه المتطلبات في المناطق التي تسري فيها حاليًا.

يتم تحديد رموز المناطق من خلال CLDR. يجب أن يكون هذا البلد أحد البلدان التي يسري فيها البرنامج تحديدًا في هذا البلد أو 001 عندما يُطبَّق البرنامج في جميع أنحاء العالم.

الطُرق

disable

إيقاف المشاركة في البرنامج المحدّد للحساب

enable

تفعيل المشاركة في البرنامج المحدّد للحساب.

get

يسترد البرنامج المحدد للحساب.

list

يسترد جميع البرامج للحساب.