Method: projects.searchApps

แสดงรายการแอปที่ใช้ได้ทั้งหมดสำหรับ FirebaseProject ที่ระบุ

นี่คือวิธีที่สะดวก โดยทั่วไปแล้ว การโต้ตอบกับแอปควรทำโดยใช้บริการเฉพาะแพลตฟอร์ม แต่กรณีการใช้งานเครื่องมือบางอย่างจำเป็นต้องมีการสรุปข้อมูลแอปที่รู้จักทั้งหมด (เช่น สำหรับอินเทอร์เฟซตัวเลือกแอป)

คำขอ HTTP

GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}:searchApps

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
parent

string

FirebaseProject หลักสำหรับแสดงรายการแอป ในรูปแบบ:

projects/PROJECT_IDENTIFIER

โปรดดูที่ช่อง FirebaseProject name เพื่อดูรายละเอียดเกี่ยวกับค่า PROJECT_IDENTIFIER

พารามิเตอร์การค้นหา

พารามิเตอร์
pageToken

string

โทเค็นที่ส่งคืนจากการเรียกไปยัง projects.searchApps ครั้งก่อน ซึ่งระบุตำแหน่งในชุดของแอปเพื่อกลับมาแสดงข้อมูลต่อ
pageSize

integer

จำนวนแอปสูงสุดที่จะแสดงในการตอบกลับ

เซิร์ฟเวอร์อาจแสดงผลน้อยกว่าค่านี้ได้ตามที่เห็นสมควร หากไม่ได้ระบุค่าไว้ (หรือระบุค่ามากเกินไป) เซิร์ฟเวอร์จะกำหนดขีดจำกัดของตนเอง

ค่านี้ต้องไม่เป็นค่าลบ
filter

string

สตริงการค้นหาที่เข้ากันได้กับมาตรฐาน AIP-160 ของ Google

ใช้ช่องใดก็ได้ต่อไปนี้ในการค้นหา

การค้นหานี้ยังสนับสนุนรูปแบบ "เสมือน" ต่อไปนี้ ด้วย ช่องเหล่านี้คือช่องที่ไม่ได้เป็นส่วนหนึ่งของออบเจ็กต์ทรัพยากรที่แสดงผล แต่ค้นหาได้ราวกับว่ามีการเติมค่าที่เฉพาะเจาะจงไว้ล่วงหน้า

  • sha1_hash หรือ sha1Hashes: ช่องนี้ถือว่าเป็นช่อง string ที่ซ้ำ ซึ่งมีรายการลายนิ้วมือใบรับรอง SHA-1 ทั้งหมดที่ลงทะเบียนกับ AndroidApp รายการนี้จะว่างเปล่าหากแอปไม่ใช่ AndroidApp
  • sha256_hash หรือ sha256Hashes: ช่องนี้ถือว่าเป็นช่อง string ที่ซ้ำ ซึ่งมีรายการลายนิ้วมือของใบรับรอง SHA-256 ทั้งหมดที่ลงทะเบียนกับ AndroidApp รายการนี้จะว่างเปล่าหากแอปไม่ใช่ AndroidApp
  • appStoreId: ช่องนี้ถือเป็นช่อง string เอกพจน์ ซึ่งมีรหัส Apple App Store ที่จดทะเบียนไว้กับ IosApp ช่องนี้จะว่างเปล่า หากแอปไม่ใช่ IosApp
  • teamId: ช่องนี้ถือเป็นช่อง string เอกพจน์ ซึ่งมีรหัสทีม Apple ที่ลงทะเบียนกับ IosApp ช่องนี้จะว่างเปล่า หากแอปไม่ใช่ IosApp
showDeleted

boolean

ควบคุมว่าควรแสดงผลแอปในสถานะ DELETED หรือไม่

หากไม่ได้ระบุ ระบบจะแสดงผลเพียง ACTIVE แอป

เนื้อความของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "apps": [
    {
      object (FirebaseAppInfo)
    }
  ],
  "nextPageToken": string
}
ช่อง
apps[]

object (FirebaseAppInfo)

ผลการค้นหา 1 หน้าจากการโทรไปที่ projects.searchApps
nextPageToken

string

ถ้ารายการผลลัพธ์มีขนาดใหญ่เกินกว่าจะรองรับคำตอบเดียว ระบบจะแสดงผลโทเค็น

คุณสามารถใช้โทเค็นนี้ในการเรียก projects.searchApps ครั้งต่อๆ ไปเพื่อหากลุ่มแอปถัดไปได้

โทเค็นของหน้ามีอายุสั้นและไม่ควรคงอยู่

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมการตรวจสอบสิทธิ์

ข้อมูลแอปของ Firebase

สรุประดับสูงของแอป

การแสดง JSON 
{
  "name": string,
  "displayName": string,
  "platform": enum (AppPlatform),
  "appId": string,
  "namespace": string,
  "apiKeyId": string,
  "state": enum (State)
}
ช่อง
name

string

ชื่อทรัพยากรของแอป Firebase ในรูปแบบ

projects/PROJECT_ID/iosApps/APP_ID

หรือ

projects/PROJECT_ID/androidApps/APP_ID

หรือ

projects/PROJECT_ID/webApps/APP_ID
displayName

string

ชื่อที่แสดงที่ผู้ใช้กำหนดของแอป Firebase
platform

enum (AppPlatform)

แพลตฟอร์มของแอป Firebase
appId

string

เอาต์พุตเท่านั้น เปลี่ยนแปลงไม่ได้ ตัวระบุที่ไม่ซ้ำกันทั่วโลกซึ่ง Firebase กำหนดสำหรับ WebApp

ตัวระบุนี้ควรถือเป็นโทเค็นที่คลุมเครือเนื่องจากไม่ได้ระบุรูปแบบข้อมูล
namespace

string

เอาต์พุตเท่านั้น เปลี่ยนแปลงไม่ได้ ตัวระบุเฉพาะแพลตฟอร์มของแอป

หมายเหตุ: สำหรับกรณีการใช้งานส่วนใหญ่ ให้ใช้ appId ซึ่งเป็นตัวระบุที่ไม่ซ้ำกันทั่วโลกตามรูปแบบบัญญัติสำหรับการอ้างอิงแอป

สตริงนี้มาจากตัวระบุแบบเนทีฟของแต่ละแพลตฟอร์ม ได้แก่ packageName สำหรับ AndroidApp, bundleId สำหรับ IosApp และ webId สำหรับ WebApp เนื้อหาควรถือว่าเป็นแบบทึบ เนื่องจากรูปแบบตัวระบุเนทีฟอาจมีการเปลี่ยนแปลงเมื่อแพลตฟอร์มพัฒนาขึ้น สตริงนี้จะไม่ซ้ำกันภายใน FirebaseProject และแอปที่เกี่ยวข้องเท่านั้น
apiKeyId

string

ตัวระบุ (UID) ที่ไม่ซ้ำกันทั่วโลกสำหรับคีย์ Firebase API ที่เชื่อมโยงกับแอป

โปรดทราบว่าค่านี้เป็น UID ของคีย์ API ไม่ใช่ keyString ของคีย์ API keyString คือค่าที่พบในอาร์ติแฟกต์การกำหนดค่าของแอป (AndroidApp | IosApp | WebApp)

หากไม่ได้ตั้งค่า apiKeyId ในคำขอสร้างแอป (AndroidApp | IosApp | WebApp) Firebase จะเชื่อมโยง apiKeyId กับแอปโดยอัตโนมัติ คีย์ที่เชื่อมโยงอัตโนมัตินี้อาจเป็นคีย์ที่ถูกต้องที่มีอยู่แล้ว หรือหากไม่มีคีย์ที่ถูกต้อง ระบบจะจัดสรรคีย์ใหม่
state

enum (State)

เอาต์พุตเท่านั้น สถานะอายุการใช้งานของแอป

แพลตฟอร์มแอป

แพลตฟอร์มที่เชื่อมโยงกับแอป Firebase ได้

Enum
PLATFORM_UNSPECIFIED ไม่ทราบสถานะ ตัวเลือกนี้ใช้เพื่อแยกค่าที่ไม่ได้ตั้งค่าเท่านั้น
IOS แอป Firebase เชื่อมโยงกับ iOS
ANDROID แอป Firebase เชื่อมโยงกับ Android
WEB แอป Firebase เชื่อมโยงกับเว็บ