Method: advertisers.campaigns.bulkListCampaignAssignedTargetingOptions
Stay organized with collections
Save and categorize content based on your preferences.
Lists assigned targeting options of a campaign across targeting types.
HTTP request
GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/campaigns/{campaignId}:bulkListCampaignAssignedTargetingOptions
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
advertiserId |
string (int64 format)
Required. The ID of the advertiser the campaign belongs to.
|
campaignId |
string (int64 format)
Required. The ID of the campaign to list assigned targeting options for.
|
Query parameters
| Parameters |
pageSize |
integer
Requested page size. The size must be an integer between 1 and 5000. If unspecified, the default is 5000. Returns error code INVALID_ARGUMENT if an invalid value is specified.
|
pageToken |
string
A token that lets the client fetch the next page of results. Typically, this is the value of nextPageToken returned from the previous call to campaigns.bulkListCampaignAssignedTargetingOptions method. If not specified, the first page of results will be returned.
|
orderBy |
string
Field by which to sort the list. Acceptable values are:
The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: targetingType desc.
|
filter |
string
Allows filtering by assigned targeting option properties. Supported syntax:
- Filter expressions are made up of one or more restrictions.
- Restrictions can be combined by the logical operator
OR on the same field.
- A restriction has the form of
{field} {operator} {value}.
- The operator must be
EQUALS (=).
- Supported fields:
targetingTypeinheritance
Examples:
- AssignedTargetingOptions of targeting type TARGETING_TYPE_LANGUAGE or TARGETING_TYPE_GENDER
targetingType="TARGETING_TYPE_LANGUAGE" OR
targetingType="TARGETING_TYPE_GENDER"
- AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER
inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"
The length of this field should be no more than 500 characters.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
{
"assignedTargetingOptions": [
{
object (AssignedTargetingOption)
}
],
"nextPageToken": string
} |
| Fields |
assignedTargetingOptions[] |
object (AssignedTargetingOption)
The list of assigned targeting options. This list will be absent if empty.
|
nextPageToken |
string
A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListCampaignAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assignedTargetingOptions to return.
|
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/display-video
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["Lists assigned targeting options of a campaign across targeting types using the `bulkListCampaignAssignedTargetingOptions` method."],["Requires specifying the advertiser ID and campaign ID in the request path."],["Supports optional query parameters for pagination, sorting, and filtering the results."],["Returns a list of assigned targeting options and a token for retrieving the next page of results if available."],["Requires authorization with the `https://www.googleapis.com/auth/display-video` scope."]]],["This API endpoint retrieves a list of assigned targeting options for a specific campaign. It uses a `GET` request with the campaign and advertiser IDs in the URL path. Optional query parameters include `pageSize` (1-5000), `pageToken` for pagination, `orderBy` for sorting (default: `targetingType`), and `filter` to refine results based on `targetingType` or `inheritance`. The request body is empty. The response contains an array of `assignedTargetingOptions` and a `nextPageToken` for pagination. OAuth scope `https://www.googleapis.com/auth/display-video` is required.\n"]]
