Display & Video 360 API v1beta2 غروب شده است. درخواستها به نسخه غروب ممکن است با خطا مواجه شوند.
باید از Display & Video 360 API v2 استفاده کنید. برای مراحل مهاجرت از نسخه 1 به نسخه 2 به راهنمای مهاجرت ما مراجعه کنید.
Method: advertisers.campaigns.list
با مجموعهها، منظم بمانید
ذخیره و دستهبندی محتوا براساس اولویتهای شما.
کمپینها را در یک تبلیغکننده فهرست میکند.
ترتیب با پارامتر orderBy
تعریف می شود. اگر filter
توسط entityStatus
مشخص نشده باشد، کمپینهای دارای ENTITY_STATUS_ARCHIVED
در نتایج لحاظ نمیشوند.
درخواست HTTP
GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/campaigns
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های |
---|
advertiserId | string ( int64 format) شناسه تبلیغکننده برای فهرست کمپینها. |
پارامترهای پرس و جو
مولفه های |
---|
pageSize | integer اندازه صفحه درخواستی باید بین 1 تا 100 باشد. اگر نامشخص باشد به طور پیش فرض 100 خواهد بود. |
pageToken | string نشانه ای که صفحه ای از نتایجی را که سرور باید برگرداند، شناسایی کند. به طور معمول، این مقدار nextPageToken است که از فراخوانی قبلی به روش campaigns.list برگردانده شده است. اگر مشخص نشده باشد، صفحه اول نتایج برگردانده خواهد شد. |
orderBy | string فیلدی که بر اساس آن لیست مرتب می شود. مقادیر قابل قبول عبارتند از: -
displayName (پیشفرض) -
entityStatus -
updateTime
ترتیب مرتب سازی پیش فرض صعودی است. برای تعیین ترتیب نزولی برای یک فیلد، پسوند "desc" باید به نام فیلد اضافه شود. مثال: displayName desc . |
filter | string اجازه فیلتر کردن بر اساس ویژگی های کمپین را می دهد. نحو پشتیبانی شده: - عبارات فیلتر از یک یا چند محدودیت تشکیل شده اند.
- محدودیت ها را می توان با عملگرهای منطقی
AND یا OR ترکیب کرد. دنباله ای از محدودیت ها به طور ضمنی از AND استفاده می کند. - یک محدودیت به شکل
{field} {operator} {value} است. - اپراتور مورد استفاده در
updateTime باید GREATER THAN OR EQUAL TO (>=) یا LESS THAN OR EQUAL TO (<=) باشد. - عملگر باید
EQUALS (=) باشد. - زمینه های پشتیبانی شده:
-
campaignId -
displayName -
entityStatus -
updateTime (ورودی در قالب ISO 8601 یا YYYY-MM-DDTHH:MM:SSZ)
مثال ها: - همه کمپینهای
ENTITY_STATUS_ACTIVE یا ENTITY_STATUS_PAUSED تحت یک تبلیغکننده: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") - همه کمپینهای با زمان بهروزرسانی کمتر یا مساوی
2020-11-04T18:54:47Z (format of ISO 8601) : updateTime<="2020-11-04T18:54:47Z" - همه کمپینهای دارای زمان بهروزرسانی بیشتر یا مساوی
2020-11-04T18:54:47Z (format of ISO 8601) : updateTime>="2020-11-04T18:54:47Z"
طول این فیلد نباید بیشتر از 500 کاراکتر باشد. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"campaigns": [
{
object (Campaign )
}
],
"nextPageToken": string
} |
زمینه های |
---|
campaigns[] | object ( Campaign ) لیست کمپین ها در صورت خالی بودن این لیست وجود نخواهد داشت. |
nextPageToken | string نشانه ای برای بازیابی صفحه بعدی نتایج. این مقدار را در قسمت pageToken در روش فراخوانی بعدی به campaigns.list ارسال کنید تا صفحه بعدی نتایج را بازیابی کنید. |
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/display-video
-
https://www.googleapis.com/auth/display-video-mediaplanning
برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2023-12-02 بهوقت ساعت هماهنگ جهانی.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"اطلاعاتی که نیاز دارم وجود ندارد"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"بیشازحد پیچیده/ مراحل بسیار زیاد"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"قدیمی"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"مشکل ترجمه"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"مشکل کد / نمونهها"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"غیره"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"درک آسان"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"مشکلم را برطرف کرد"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"غیره"
}]