Method: projects.searchApps

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

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

คำขอ HTTP

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

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

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

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

string

FirebaseProject หลักที่จะแสดงรายการแอปในรูปแบบ:

projects/ PROJECT_IDENTIFIER

โปรดดูช่อง name FirebaseProject สำหรับรายละเอียดเกี่ยวกับค่า 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 ID ที่ลงทะเบียนกับ IosApp ช่องนี้จะว่างเปล่าหากแอปไม่ใช่ IosApp
  • teamId : ฟิลด์นี้ถือเป็นฟิลด์ string เอกพจน์ ซึ่งมีรหัสทีม Apple ที่ลงทะเบียนกับ IosApp ช่องนี้จะว่างเปล่าหากแอปไม่ใช่ IosApp
showDeleted

boolean

ควบคุมว่าควรส่งคืนแอปที่อยู่ในสถานะ DELETED หรือไม่

หากไม่ได้ระบุไว้ ระบบจะส่งคืนเฉพาะแอป ACTIVE เท่านั้น

ขอร่างกาย

เนื้อความของคำขอจะต้องว่างเปล่า

ร่างกายตอบสนอง

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

การเป็นตัวแทน JSON
{
  "apps": [
    {
      object (FirebaseAppInfo)
    }
  ],
  "nextPageToken": string
}
เขตข้อมูล
apps[]

object ( FirebaseAppInfo )

ผลลัพธ์หนึ่งหน้าจากการเรียกไปยัง 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

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

FirebaseAppInfo

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

การเป็นตัวแทน 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) ที่กำหนดโดย Google ที่ไม่ซ้ำกันทั่วโลกสำหรับคีย์ Firebase API ที่เชื่อมโยงกับแอป

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

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

state

enum ( State )

เอาท์พุทเท่านั้น สถานะวงจรชีวิตของแอป

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

แพลตฟอร์มที่สามารถเชื่อมโยงแอป Firebase ได้

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