- درخواست HTTP
- پارامترهای مسیر
- پارامترهای پرس و جو
- درخواست بدنه
- بدنه پاسخ
- دامنههای مجوز
- برنامه
- اطلاعات برنامه دستی
- اطلاعات برنامه لینکدین
- وضعیت تأیید برنامه
- مثالها
- امتحانش کن!
برنامهها را در حساب کاربری AdMob مشخص شده فهرست کنید.
درخواست HTTP
GET https://admob.googleapis.com/v1/{parent=accounts/*}/apps
این URL از سینتکس Transcoding در gRPC استفاده میکند.
پارامترهای مسیر
| پارامترها | |
|---|---|
parent | الزامی. نام منبع حسابی که قرار است برنامهها برای آن فهرست شوند. مثال: accounts/pub-9876543210987654 |
پارامترهای پرس و جو
| پارامترها | |
|---|---|
pageSize | حداکثر تعداد برنامههایی که باید برگردانده شوند. اگر مشخص نشود یا 0 باشد، حداکثر 10،000 برنامه برگردانده خواهد شد. حداکثر مقدار 20،000 است؛ مقادیر بالاتر از 20،000 به 20،000 کاهش مییابد. |
pageToken | مقداری که توسط آخرین |
درخواست بدنه
بدنه درخواست باید خالی باشد.
بدنه پاسخ
پاسخ به درخواست فهرست برنامهها.
در صورت موفقیت، بدنه پاسخ شامل دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{
"apps": [
{
object ( |
| فیلدها | |
|---|---|
apps[] | برنامههای حاصل برای حساب درخواستی. |
nextPageToken | اگر خالی نباشد، نشان میدهد که ممکن است برنامههای بیشتری برای درخواست وجود داشته باشد؛ این مقدار باید در یک |
دامنههای مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/admob.readonly
برای اطلاعات بیشتر، بهOAuth 2.0 Overview .
برنامه
یک برنامه AdMob را برای یک پلتفرم خاص (مثلاً: اندروید یا iOS) توصیف میکند.
| نمایش JSON |
|---|
{ "name": string, "appId": string, "platform": string, "manualAppInfo": { object ( |
| فیلدها | |
|---|---|
name | نام منبع برای این برنامه. فرمت آن accounts/{publisherId}/apps/{app_id_fragment} است. مثال: accounts/pub-9876543210987654/apps/0123456789 |
appId | شناسهی قابل مشاهدهی خارجی برنامه که میتواند برای ادغام با AdMob SDK استفاده شود. این یک ویژگی فقط خواندنی است. مثال: ca-app-pub-9876543210987654~0123456789 |
platform | پلتفرم برنامه را شرح میدهد. محدود به «IOS» و «ANDROID». |
manualAppInfo | اطلاعات مربوط به برنامهای که به هیچ فروشگاه برنامهای مرتبط نیست. پس از اتصال برنامه، این اطلاعات همچنان قابل بازیابی هستند. اگر هنگام ایجاد برنامه هیچ نامی برای آن ارائه نشود، از یک نام جایگزین استفاده خواهد شد. |
linkedAppInfo | تغییرناپذیر. اطلاعات مربوط به یک برنامه که به یک فروشگاه برنامه مرتبط است. این فیلد فقط و فقط در صورتی وجود دارد که برنامه به یک فروشگاه برنامه (app store) لینک شده باشد. |
appApprovalState | فقط خروجی. وضعیت تأیید برنامه. این فیلد فقط خواندنی است. |
اطلاعات برنامه دستی
اطلاعات ارائه شده برای برنامههای دستی که به فروشگاه برنامهای مرتبط نیستند (مثال: گوگل پلی، اپ استور).
| نمایش JSON |
|---|
{ "displayName": string } |
| فیلدها | |
|---|---|
displayName | نام نمایشی برنامه همانطور که در رابط کاربری AdMob نشان داده شده است، توسط کاربر ارائه میشود. حداکثر طول مجاز ۸۰ کاراکتر است. |
اطلاعات برنامه لینکدین
اطلاعات از فروشگاه برنامه در صورتی که برنامه به یک فروشگاه برنامه مرتبط باشد.
| نمایش JSON |
|---|
{ "appStoreId": string, "displayName": string } |
| فیلدها | |
|---|---|
appStoreId | شناسه فروشگاه برنامه؛ اگر و فقط اگر برنامه به یک فروشگاه برنامه مرتبط باشد، ارائه میشود. اگر برنامه به فروشگاه گوگل پلی اضافه شود، شناسه برنامه، شناسه برنامه خواهد بود. برای مثال: "com.example.myapp". به https://developer.android.com/studio/build/application-id مراجعه کنید. اگر برنامه به فروشگاه اپل اپ اضافه شود، شناسه فروشگاه اپ خواهد بود. برای مثال "105169111". توجه داشته باشید که تنظیم شناسه فروشگاه برنامه یک اقدام برگشتناپذیر محسوب میشود. پس از اتصال یک برنامه، نمیتوان آن را لغو کرد. |
displayName | فقط خروجی. نام برنامه را همانطور که در فروشگاه برنامه نمایش داده میشود نمایش دهید. این یک فیلد فقط برای خروجی است و اگر برنامه در فروشگاه یافت نشود، ممکن است خالی باشد. |
وضعیت تأیید برنامه
تأییدیه برنامه، یک برنامه تلفن همراه را تأیید میکند.
| انومها | |
|---|---|
APP_APPROVAL_STATE_UNSPECIFIED | مقدار پیشفرض برای فیلد تنظیم نشده. استفاده نکنید. |
ACTION_REQUIRED | این برنامه برای تأیید نیاز به اقدامات اضافی کاربر دارد. لطفاً برای جزئیات و مراحل بعدی به https://support.google.com/admob/answer/10564477 مراجعه کنید. |
IN_REVIEW | برنامه در انتظار بررسی است. |
APPROVED | این برنامه تأیید شده است و میتواند تبلیغات ارائه دهد. |