از
8 سپتامبر 2025 ، هر مورد خط جدید باید اعلام کند که آیا تبلیغات سیاسی اتحادیه اروپا (EU) را ارائه می دهد یا خیر. Display & Video 360 API و بارگذاریهای SDF که اعلانها را ارائه نمیکنند با شکست مواجه میشوند. برای جزئیات بیشتر در مورد نحوه به روز رسانی یکپارچه سازی خود برای ایجاد این اعلامیه، به
صفحه لغو اعتبار ما مراجعه کنید.
Method: googleAudiences.list
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
مخاطبان گوگل را فهرست می کند.
ترتیب با پارامتر orderBy
تعریف می شود.
درخواست HTTP
GET https://displayvideo.googleapis.com/v4/googleAudiences
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
پارامترها |
---|
pageSize | integer اندازه صفحه درخواستی باید بین 1 تا 200 باشد. اگر نامشخص باشد به طور پیش فرض 100 خواهد بود. اگر مقدار نامعتبری مشخص شده باشد، کد خطا INVALID_ARGUMENT را برمیگرداند. |
pageToken | string نشانه ای که صفحه ای از نتایجی را که سرور باید برگرداند، شناسایی کند. به طور معمول، این مقدار nextPageToken است که از تماس قبلی به روش googleAudiences.list برگردانده شده است. اگر مشخص نشده باشد، صفحه اول نتایج برگردانده خواهد شد. |
orderBy | string فیلدی که بر اساس آن لیست مرتب می شود. مقادیر قابل قبول عبارتند از: -
googleAudienceId (پیشفرض) -
displayName
ترتیب مرتب سازی پیش فرض صعودی است. برای تعیین ترتیب نزولی برای یک فیلد، پسوند "desc" باید به نام فیلد اضافه شود. مثال: displayName desc . |
filter | string فیلتر کردن بر اساس فیلدهای مخاطب Google را امکان پذیر می کند. نحو پشتیبانی شده: - عبارات فیلتر برای مخاطبان Google فقط می تواند حداکثر یک محدودیت داشته باشد.
- یک محدودیت به شکل
{field} {operator} {value} است. - همه فیلدها باید از عملگر
HAS (:) استفاده کنند.
زمینه های پشتیبانی شده: مثال ها: - همه مخاطبان Google که نام نمایشی آنها حاوی "Google" است:
displayName:"Google" .
طول این فیلد نباید بیشتر از 500 کاراکتر باشد. برای اطلاعات بیشتر به راهنمای درخواست های LIST فیلتر ما مراجعه کنید. |
accessor پارامتر اتحادیه مورد نیاز. مشخص می کند که درخواست در کدام نهاد DV360 در حال انجام است. درخواست LIST فقط موجودیتهای مخاطب Google را برمیگرداند که برای نهاد DV360 شناساییشده در accessor قابل دسترسی هستند. accessor می تواند تنها یکی از موارد زیر باشد: |
partnerId | string ( int64 format) شناسه شریکی که به مخاطبان Google واکشی شده دسترسی دارد. |
advertiserId | string ( int64 format) شناسه تبلیغکنندهای که به مخاطبان Google واکشی شده دسترسی دارد. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"googleAudiences": [
{
object (GoogleAudience )
}
],
"nextPageToken": string
} |
فیلدها |
---|
googleAudiences[] | object ( GoogleAudience ) لیست مخاطبان گوگل در صورت خالی بودن این لیست وجود نخواهد داشت. |
nextPageToken | string نشانه ای برای بازیابی صفحه بعدی نتایج. این مقدار را در قسمت pageToken در تماس بعدی با روش googleAudiences.list ارسال کنید تا صفحه بعدی نتایج را بازیابی کنید. |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/display-video
برای اطلاعات بیشتر، بهOAuth 2.0 Overview .
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],["This document details the API for listing Google audiences via a `GET` request to `https://displayvideo.googleapis.com/v4/googleAudiences`. Key actions include specifying `pageSize`, `pageToken`, `orderBy`, and `filter` in query parameters to control results. The request can identify access via `partnerId` or `advertiserId`. The response includes a list of Google audiences and a `nextPageToken` for pagination. Authorization requires the `https://www.googleapis.com/auth/display-video` scope.\n"],null,["# Method: googleAudiences.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListGoogleAudiencesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists Google audiences.\n\nThe order is defined by the [orderBy](/display-video/api/reference/rest/v4/googleAudiences/list#body.QUERY_PARAMETERS.order_by) parameter.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v4/googleAudiences`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |\n| `pageToken` | `string` A token identifying a page of results the server should return. Typically, this is the value of [nextPageToken](/display-video/api/reference/rest/v4/googleAudiences/list#body.ListGoogleAudiencesResponse.FIELDS.next_page_token) returned from the previous call to `googleAudiences.list` method. If not specified, the first page of results will be returned. |\n| `orderBy` | `string` Field by which to sort the list. Acceptable values are: - `googleAudienceId` (default) - `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`. |\n| `filter` | `string` Allows filtering by Google audience fields. Supported syntax: - Filter expressions for Google audiences can only contain at most one restriction. - A restriction has the form of `{field} {operator} {value}`. - All fields must use the `HAS (:)` operator. Supported fields: - `displayName` Examples: - All Google audiences for which the display name contains \"Google\": `displayName:\"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |\n| Union parameter `accessor`. Required. Identifies which DV360 entity the request is being made within. The LIST request will only return Google audience entities that are accessible to the DV360 entity identified within the `accessor`. `accessor` can be only one of the following: ||\n| `partnerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the partner that has access to the fetched Google audiences. |\n| `advertiserId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the advertiser that has access to the fetched Google audiences. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"googleAudiences\": [ { object (/display-video/api/reference/rest/v4/googleAudiences#GoogleAudience) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `googleAudiences[]` | `object (`[GoogleAudience](/display-video/api/reference/rest/v4/googleAudiences#GoogleAudience)`)` The list of Google audiences. This list will be absent if empty. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [pageToken](/display-video/api/reference/rest/v4/googleAudiences/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `googleAudiences.list` method to retrieve the next page of results. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/display-video`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]