@maxim_mazurok/gapi.client.displayvideo-v4 0.0.20250625 → 0.0.20250729
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +364 -1
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://displayvideo.googleapis.com/$discovery/rest?version=v4
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250729
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -682,6 +682,18 @@ declare namespace gapi.client {
|
|
|
682
682
|
/** A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more line_item_assigned_targeting_options to return. */
|
|
683
683
|
nextPageToken?: string;
|
|
684
684
|
}
|
|
685
|
+
interface BulkListCampaignAssignedTargetingOptionsResponse {
|
|
686
|
+
/** The list of assigned targeting options. This list will be absent if empty. */
|
|
687
|
+
assignedTargetingOptions?: AssignedTargetingOption[];
|
|
688
|
+
/** 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 assigned_targeting_options to return. */
|
|
689
|
+
nextPageToken?: string;
|
|
690
|
+
}
|
|
691
|
+
interface BulkListInsertionOrderAssignedTargetingOptionsResponse {
|
|
692
|
+
/** The list of assigned targeting options. This list will be absent if empty. */
|
|
693
|
+
assignedTargetingOptions?: AssignedTargetingOption[];
|
|
694
|
+
/** A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListInsertionOrderAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return. */
|
|
695
|
+
nextPageToken?: string;
|
|
696
|
+
}
|
|
685
697
|
interface BulkUpdateLineItemsRequest {
|
|
686
698
|
/** Required. IDs of line items to update. */
|
|
687
699
|
lineItemIds?: string[];
|
|
@@ -2055,6 +2067,12 @@ declare namespace gapi.client {
|
|
|
2055
2067
|
/** A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAssignedLocations` method to retrieve the next page of results. */
|
|
2056
2068
|
nextPageToken?: string;
|
|
2057
2069
|
}
|
|
2070
|
+
interface ListCampaignAssignedTargetingOptionsResponse {
|
|
2071
|
+
/** The list of assigned targeting options. This list will be absent if empty. */
|
|
2072
|
+
assignedTargetingOptions?: AssignedTargetingOption[];
|
|
2073
|
+
/** A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListCampaignAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return. */
|
|
2074
|
+
nextPageToken?: string;
|
|
2075
|
+
}
|
|
2058
2076
|
interface ListCampaignsResponse {
|
|
2059
2077
|
/** The list of campaigns. This list will be absent if empty. */
|
|
2060
2078
|
campaigns?: Campaign[];
|
|
@@ -2127,6 +2145,12 @@ declare namespace gapi.client {
|
|
|
2127
2145
|
/** A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListGuaranteedOrders` method to retrieve the next page of results. */
|
|
2128
2146
|
nextPageToken?: string;
|
|
2129
2147
|
}
|
|
2148
|
+
interface ListInsertionOrderAssignedTargetingOptionsResponse {
|
|
2149
|
+
/** The list of assigned targeting options. This list will be absent if empty. */
|
|
2150
|
+
assignedTargetingOptions?: AssignedTargetingOption[];
|
|
2151
|
+
/** A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListInsertionOrderAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return. */
|
|
2152
|
+
nextPageToken?: string;
|
|
2153
|
+
}
|
|
2130
2154
|
interface ListInsertionOrdersResponse {
|
|
2131
2155
|
/** The list of insertion orders. This list will be absent if empty. */
|
|
2132
2156
|
insertionOrders?: InsertionOrder[];
|
|
@@ -2899,6 +2923,14 @@ declare namespace gapi.client {
|
|
|
2899
2923
|
/** Output only. User rewarded content status for video ads. */
|
|
2900
2924
|
userRewardedContent?: string;
|
|
2901
2925
|
}
|
|
2926
|
+
interface VideoAdInventoryControl {
|
|
2927
|
+
/** Optional. Whether ads can serve as in-feed format. */
|
|
2928
|
+
allowInFeed?: boolean;
|
|
2929
|
+
/** Optional. Whether ads can serve as in-stream format. */
|
|
2930
|
+
allowInStream?: boolean;
|
|
2931
|
+
/** Optional. Whether ads can serve as shorts format. */
|
|
2932
|
+
allowShorts?: boolean;
|
|
2933
|
+
}
|
|
2902
2934
|
interface VideoAdSequenceSettings {
|
|
2903
2935
|
/** The minimum time interval before the same user sees this sequence again. */
|
|
2904
2936
|
minimumDuration?: string;
|
|
@@ -3004,6 +3036,8 @@ declare namespace gapi.client {
|
|
|
3004
3036
|
targetFrequency?: TargetFrequency;
|
|
3005
3037
|
/** Optional. The third-party measurement configs of the line item. */
|
|
3006
3038
|
thirdPartyMeasurementConfigs?: ThirdPartyMeasurementConfigs;
|
|
3039
|
+
/** Optional. The settings to control which inventory is allowed for this line item. */
|
|
3040
|
+
videoAdInventoryControl?: VideoAdInventoryControl;
|
|
3007
3041
|
/** Optional. The settings related to VideoAdSequence. */
|
|
3008
3042
|
videoAdSequenceSettings?: VideoAdSequenceSettings;
|
|
3009
3043
|
/** The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. */
|
|
@@ -3334,6 +3368,83 @@ declare namespace gapi.client {
|
|
|
3334
3368
|
body: CreateAssetRequest,
|
|
3335
3369
|
): Request<CreateAssetResponse>;
|
|
3336
3370
|
}
|
|
3371
|
+
interface AssignedTargetingOptionsResource {
|
|
3372
|
+
/** Gets a single targeting option assigned to a campaign. */
|
|
3373
|
+
get(request?: {
|
|
3374
|
+
/** V1 error format. */
|
|
3375
|
+
'$.xgafv'?: string;
|
|
3376
|
+
/** OAuth access token. */
|
|
3377
|
+
access_token?: string;
|
|
3378
|
+
/** Required. The ID of the advertiser the campaign belongs to. */
|
|
3379
|
+
advertiserId: string;
|
|
3380
|
+
/** Data format for response. */
|
|
3381
|
+
alt?: string;
|
|
3382
|
+
/** Required. An identifier unique to the targeting type in this campaign that identifies the assigned targeting option being requested. */
|
|
3383
|
+
assignedTargetingOptionId: string;
|
|
3384
|
+
/** JSONP */
|
|
3385
|
+
callback?: string;
|
|
3386
|
+
/** Required. The ID of the campaign the assigned targeting option belongs to. */
|
|
3387
|
+
campaignId: string;
|
|
3388
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3389
|
+
fields?: string;
|
|
3390
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3391
|
+
key?: string;
|
|
3392
|
+
/** OAuth 2.0 token for the current user. */
|
|
3393
|
+
oauth_token?: string;
|
|
3394
|
+
/** Returns response with indentations and line breaks. */
|
|
3395
|
+
prettyPrint?: boolean;
|
|
3396
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3397
|
+
quotaUser?: string;
|
|
3398
|
+
/** Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY` */
|
|
3399
|
+
targetingType: string;
|
|
3400
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3401
|
+
upload_protocol?: string;
|
|
3402
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3403
|
+
uploadType?: string;
|
|
3404
|
+
}): Request<AssignedTargetingOption>;
|
|
3405
|
+
/** Lists the targeting options assigned to a campaign for a specified targeting type. */
|
|
3406
|
+
list(request?: {
|
|
3407
|
+
/** V1 error format. */
|
|
3408
|
+
'$.xgafv'?: string;
|
|
3409
|
+
/** OAuth access token. */
|
|
3410
|
+
access_token?: string;
|
|
3411
|
+
/** Required. The ID of the advertiser the campaign belongs to. */
|
|
3412
|
+
advertiserId: string;
|
|
3413
|
+
/** Data format for response. */
|
|
3414
|
+
alt?: string;
|
|
3415
|
+
/** JSONP */
|
|
3416
|
+
callback?: string;
|
|
3417
|
+
/** Required. The ID of the campaign to list assigned targeting options for. */
|
|
3418
|
+
campaignId: string;
|
|
3419
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3420
|
+
fields?: string;
|
|
3421
|
+
/** Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources 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. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. */
|
|
3422
|
+
filter?: string;
|
|
3423
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3424
|
+
key?: string;
|
|
3425
|
+
/** OAuth 2.0 token for the current user. */
|
|
3426
|
+
oauth_token?: string;
|
|
3427
|
+
/** Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. */
|
|
3428
|
+
orderBy?: string;
|
|
3429
|
+
/** Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. */
|
|
3430
|
+
pageSize?: number;
|
|
3431
|
+
/** A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned. */
|
|
3432
|
+
pageToken?: string;
|
|
3433
|
+
/** Returns response with indentations and line breaks. */
|
|
3434
|
+
prettyPrint?: boolean;
|
|
3435
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3436
|
+
quotaUser?: string;
|
|
3437
|
+
/** Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY` */
|
|
3438
|
+
targetingType: string;
|
|
3439
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3440
|
+
upload_protocol?: string;
|
|
3441
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3442
|
+
uploadType?: string;
|
|
3443
|
+
}): Request<ListCampaignAssignedTargetingOptionsResponse>;
|
|
3444
|
+
}
|
|
3445
|
+
interface TargetingTypesResource {
|
|
3446
|
+
assignedTargetingOptions: AssignedTargetingOptionsResource;
|
|
3447
|
+
}
|
|
3337
3448
|
interface CampaignsResource {
|
|
3338
3449
|
/** Creates a new campaign. Returns the newly created campaign if successful. */
|
|
3339
3450
|
create(request: {
|
|
@@ -3486,6 +3597,43 @@ declare namespace gapi.client {
|
|
|
3486
3597
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3487
3598
|
uploadType?: string;
|
|
3488
3599
|
}): Request<ListCampaignsResponse>;
|
|
3600
|
+
/** Lists assigned targeting options of a campaign across targeting types. */
|
|
3601
|
+
listAssignedTargetingOptions(request?: {
|
|
3602
|
+
/** V1 error format. */
|
|
3603
|
+
'$.xgafv'?: string;
|
|
3604
|
+
/** OAuth access token. */
|
|
3605
|
+
access_token?: string;
|
|
3606
|
+
/** Required. The ID of the advertiser the campaign belongs to. */
|
|
3607
|
+
advertiserId: string;
|
|
3608
|
+
/** Data format for response. */
|
|
3609
|
+
alt?: string;
|
|
3610
|
+
/** JSONP */
|
|
3611
|
+
callback?: string;
|
|
3612
|
+
/** Required. The ID of the campaign to list assigned targeting options for. */
|
|
3613
|
+
campaignId: string;
|
|
3614
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3615
|
+
fields?: string;
|
|
3616
|
+
/** Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE` or `TARGETING_TYPE_GENDER`: `targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER"` * `AssignedTargetingOption` resources 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. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. */
|
|
3617
|
+
filter?: string;
|
|
3618
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3619
|
+
key?: string;
|
|
3620
|
+
/** OAuth 2.0 token for the current user. */
|
|
3621
|
+
oauth_token?: string;
|
|
3622
|
+
/** Field by which to sort the list. Acceptable values are: * `targetingType` (default) 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`. */
|
|
3623
|
+
orderBy?: string;
|
|
3624
|
+
/** 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. */
|
|
3625
|
+
pageSize?: number;
|
|
3626
|
+
/** A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned. */
|
|
3627
|
+
pageToken?: string;
|
|
3628
|
+
/** Returns response with indentations and line breaks. */
|
|
3629
|
+
prettyPrint?: boolean;
|
|
3630
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3631
|
+
quotaUser?: string;
|
|
3632
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3633
|
+
upload_protocol?: string;
|
|
3634
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3635
|
+
uploadType?: string;
|
|
3636
|
+
}): Request<BulkListCampaignAssignedTargetingOptionsResponse>;
|
|
3489
3637
|
/** Updates an existing campaign. Returns the updated campaign if successful. */
|
|
3490
3638
|
patch(request: {
|
|
3491
3639
|
/** V1 error format. */
|
|
@@ -3552,6 +3700,7 @@ declare namespace gapi.client {
|
|
|
3552
3700
|
},
|
|
3553
3701
|
body: Campaign,
|
|
3554
3702
|
): Request<Campaign>;
|
|
3703
|
+
targetingTypes: TargetingTypesResource;
|
|
3555
3704
|
}
|
|
3556
3705
|
interface SitesResource {
|
|
3557
3706
|
/** Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites. */
|
|
@@ -4239,6 +4388,182 @@ declare namespace gapi.client {
|
|
|
4239
4388
|
body: Creative,
|
|
4240
4389
|
): Request<Creative>;
|
|
4241
4390
|
}
|
|
4391
|
+
interface AssignedTargetingOptionsResource {
|
|
4392
|
+
/** Assigns a targeting option to an insertion order. Returns the assigned targeting option if successful. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` */
|
|
4393
|
+
create(request: {
|
|
4394
|
+
/** V1 error format. */
|
|
4395
|
+
'$.xgafv'?: string;
|
|
4396
|
+
/** OAuth access token. */
|
|
4397
|
+
access_token?: string;
|
|
4398
|
+
/** Required. The ID of the advertiser the insertion order belongs to. */
|
|
4399
|
+
advertiserId: string;
|
|
4400
|
+
/** Data format for response. */
|
|
4401
|
+
alt?: string;
|
|
4402
|
+
/** JSONP */
|
|
4403
|
+
callback?: string;
|
|
4404
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4405
|
+
fields?: string;
|
|
4406
|
+
/** Required. The ID of the insertion order the assigned targeting option will belong to. */
|
|
4407
|
+
insertionOrderId: string;
|
|
4408
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4409
|
+
key?: string;
|
|
4410
|
+
/** OAuth 2.0 token for the current user. */
|
|
4411
|
+
oauth_token?: string;
|
|
4412
|
+
/** Returns response with indentations and line breaks. */
|
|
4413
|
+
prettyPrint?: boolean;
|
|
4414
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4415
|
+
quotaUser?: string;
|
|
4416
|
+
/** Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` */
|
|
4417
|
+
targetingType: string;
|
|
4418
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4419
|
+
upload_protocol?: string;
|
|
4420
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4421
|
+
uploadType?: string;
|
|
4422
|
+
/** Request body */
|
|
4423
|
+
resource: AssignedTargetingOption;
|
|
4424
|
+
}): Request<AssignedTargetingOption>;
|
|
4425
|
+
create(
|
|
4426
|
+
request: {
|
|
4427
|
+
/** V1 error format. */
|
|
4428
|
+
'$.xgafv'?: string;
|
|
4429
|
+
/** OAuth access token. */
|
|
4430
|
+
access_token?: string;
|
|
4431
|
+
/** Required. The ID of the advertiser the insertion order belongs to. */
|
|
4432
|
+
advertiserId: string;
|
|
4433
|
+
/** Data format for response. */
|
|
4434
|
+
alt?: string;
|
|
4435
|
+
/** JSONP */
|
|
4436
|
+
callback?: string;
|
|
4437
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4438
|
+
fields?: string;
|
|
4439
|
+
/** Required. The ID of the insertion order the assigned targeting option will belong to. */
|
|
4440
|
+
insertionOrderId: string;
|
|
4441
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4442
|
+
key?: string;
|
|
4443
|
+
/** OAuth 2.0 token for the current user. */
|
|
4444
|
+
oauth_token?: string;
|
|
4445
|
+
/** Returns response with indentations and line breaks. */
|
|
4446
|
+
prettyPrint?: boolean;
|
|
4447
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4448
|
+
quotaUser?: string;
|
|
4449
|
+
/** Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` */
|
|
4450
|
+
targetingType: string;
|
|
4451
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4452
|
+
upload_protocol?: string;
|
|
4453
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4454
|
+
uploadType?: string;
|
|
4455
|
+
},
|
|
4456
|
+
body: AssignedTargetingOption,
|
|
4457
|
+
): Request<AssignedTargetingOption>;
|
|
4458
|
+
/** Deletes an assigned targeting option from an insertion order. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` */
|
|
4459
|
+
delete(request?: {
|
|
4460
|
+
/** V1 error format. */
|
|
4461
|
+
'$.xgafv'?: string;
|
|
4462
|
+
/** OAuth access token. */
|
|
4463
|
+
access_token?: string;
|
|
4464
|
+
/** Required. The ID of the advertiser the insertion order belongs to. */
|
|
4465
|
+
advertiserId: string;
|
|
4466
|
+
/** Data format for response. */
|
|
4467
|
+
alt?: string;
|
|
4468
|
+
/** Required. The ID of the assigned targeting option to delete. */
|
|
4469
|
+
assignedTargetingOptionId: string;
|
|
4470
|
+
/** JSONP */
|
|
4471
|
+
callback?: string;
|
|
4472
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4473
|
+
fields?: string;
|
|
4474
|
+
/** Required. The ID of the insertion order the assigned targeting option belongs to. */
|
|
4475
|
+
insertionOrderId: string;
|
|
4476
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4477
|
+
key?: string;
|
|
4478
|
+
/** OAuth 2.0 token for the current user. */
|
|
4479
|
+
oauth_token?: string;
|
|
4480
|
+
/** Returns response with indentations and line breaks. */
|
|
4481
|
+
prettyPrint?: boolean;
|
|
4482
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4483
|
+
quotaUser?: string;
|
|
4484
|
+
/** Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` */
|
|
4485
|
+
targetingType: string;
|
|
4486
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4487
|
+
upload_protocol?: string;
|
|
4488
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4489
|
+
uploadType?: string;
|
|
4490
|
+
}): Request<{}>;
|
|
4491
|
+
/** Gets a single targeting option assigned to an insertion order. */
|
|
4492
|
+
get(request?: {
|
|
4493
|
+
/** V1 error format. */
|
|
4494
|
+
'$.xgafv'?: string;
|
|
4495
|
+
/** OAuth access token. */
|
|
4496
|
+
access_token?: string;
|
|
4497
|
+
/** Required. The ID of the advertiser the insertion order belongs to. */
|
|
4498
|
+
advertiserId: string;
|
|
4499
|
+
/** Data format for response. */
|
|
4500
|
+
alt?: string;
|
|
4501
|
+
/** Required. An identifier unique to the targeting type in this insertion order that identifies the assigned targeting option being requested. */
|
|
4502
|
+
assignedTargetingOptionId: string;
|
|
4503
|
+
/** JSONP */
|
|
4504
|
+
callback?: string;
|
|
4505
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4506
|
+
fields?: string;
|
|
4507
|
+
/** Required. The ID of the insertion order the assigned targeting option belongs to. */
|
|
4508
|
+
insertionOrderId: string;
|
|
4509
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4510
|
+
key?: string;
|
|
4511
|
+
/** OAuth 2.0 token for the current user. */
|
|
4512
|
+
oauth_token?: string;
|
|
4513
|
+
/** Returns response with indentations and line breaks. */
|
|
4514
|
+
prettyPrint?: boolean;
|
|
4515
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4516
|
+
quotaUser?: string;
|
|
4517
|
+
/** Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` */
|
|
4518
|
+
targetingType: string;
|
|
4519
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4520
|
+
upload_protocol?: string;
|
|
4521
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4522
|
+
uploadType?: string;
|
|
4523
|
+
}): Request<AssignedTargetingOption>;
|
|
4524
|
+
/** Lists the targeting options assigned to an insertion order. */
|
|
4525
|
+
list(request?: {
|
|
4526
|
+
/** V1 error format. */
|
|
4527
|
+
'$.xgafv'?: string;
|
|
4528
|
+
/** OAuth access token. */
|
|
4529
|
+
access_token?: string;
|
|
4530
|
+
/** Required. The ID of the advertiser the insertion order belongs to. */
|
|
4531
|
+
advertiserId: string;
|
|
4532
|
+
/** Data format for response. */
|
|
4533
|
+
alt?: string;
|
|
4534
|
+
/** JSONP */
|
|
4535
|
+
callback?: string;
|
|
4536
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4537
|
+
fields?: string;
|
|
4538
|
+
/** Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources 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. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. */
|
|
4539
|
+
filter?: string;
|
|
4540
|
+
/** Required. The ID of the insertion order to list assigned targeting options for. */
|
|
4541
|
+
insertionOrderId: string;
|
|
4542
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4543
|
+
key?: string;
|
|
4544
|
+
/** OAuth 2.0 token for the current user. */
|
|
4545
|
+
oauth_token?: string;
|
|
4546
|
+
/** Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. */
|
|
4547
|
+
orderBy?: string;
|
|
4548
|
+
/** Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. */
|
|
4549
|
+
pageSize?: number;
|
|
4550
|
+
/** A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned. */
|
|
4551
|
+
pageToken?: string;
|
|
4552
|
+
/** Returns response with indentations and line breaks. */
|
|
4553
|
+
prettyPrint?: boolean;
|
|
4554
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4555
|
+
quotaUser?: string;
|
|
4556
|
+
/** Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` */
|
|
4557
|
+
targetingType: string;
|
|
4558
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4559
|
+
upload_protocol?: string;
|
|
4560
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4561
|
+
uploadType?: string;
|
|
4562
|
+
}): Request<ListInsertionOrderAssignedTargetingOptionsResponse>;
|
|
4563
|
+
}
|
|
4564
|
+
interface TargetingTypesResource {
|
|
4565
|
+
assignedTargetingOptions: AssignedTargetingOptionsResource;
|
|
4566
|
+
}
|
|
4242
4567
|
interface InsertionOrdersResource {
|
|
4243
4568
|
/** Creates a new insertion order. Returns the newly created insertion order if successful. */
|
|
4244
4569
|
create(request: {
|
|
@@ -4391,6 +4716,43 @@ declare namespace gapi.client {
|
|
|
4391
4716
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4392
4717
|
uploadType?: string;
|
|
4393
4718
|
}): Request<ListInsertionOrdersResponse>;
|
|
4719
|
+
/** Lists assigned targeting options of an insertion order across targeting types. */
|
|
4720
|
+
listAssignedTargetingOptions(request?: {
|
|
4721
|
+
/** V1 error format. */
|
|
4722
|
+
'$.xgafv'?: string;
|
|
4723
|
+
/** OAuth access token. */
|
|
4724
|
+
access_token?: string;
|
|
4725
|
+
/** Required. The ID of the advertiser the insertion order belongs to. */
|
|
4726
|
+
advertiserId: string;
|
|
4727
|
+
/** Data format for response. */
|
|
4728
|
+
alt?: string;
|
|
4729
|
+
/** JSONP */
|
|
4730
|
+
callback?: string;
|
|
4731
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4732
|
+
fields?: string;
|
|
4733
|
+
/** Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources 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. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. */
|
|
4734
|
+
filter?: string;
|
|
4735
|
+
/** Required. The ID of the insertion order to list assigned targeting options for. */
|
|
4736
|
+
insertionOrderId: string;
|
|
4737
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4738
|
+
key?: string;
|
|
4739
|
+
/** OAuth 2.0 token for the current user. */
|
|
4740
|
+
oauth_token?: string;
|
|
4741
|
+
/** Field by which to sort the list. Acceptable values are: * `targetingType` (default) 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`. */
|
|
4742
|
+
orderBy?: string;
|
|
4743
|
+
/** 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. */
|
|
4744
|
+
pageSize?: number;
|
|
4745
|
+
/** A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned. */
|
|
4746
|
+
pageToken?: string;
|
|
4747
|
+
/** Returns response with indentations and line breaks. */
|
|
4748
|
+
prettyPrint?: boolean;
|
|
4749
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4750
|
+
quotaUser?: string;
|
|
4751
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4752
|
+
upload_protocol?: string;
|
|
4753
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4754
|
+
uploadType?: string;
|
|
4755
|
+
}): Request<BulkListInsertionOrderAssignedTargetingOptionsResponse>;
|
|
4394
4756
|
/** Updates an existing insertion order. Returns the updated insertion order if successful. */
|
|
4395
4757
|
patch(request: {
|
|
4396
4758
|
/** V1 error format. */
|
|
@@ -4457,6 +4819,7 @@ declare namespace gapi.client {
|
|
|
4457
4819
|
},
|
|
4458
4820
|
body: InsertionOrder,
|
|
4459
4821
|
): Request<InsertionOrder>;
|
|
4822
|
+
targetingTypes: TargetingTypesResource;
|
|
4460
4823
|
}
|
|
4461
4824
|
interface InvoicesResource {
|
|
4462
4825
|
/** Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method. */
|