@maxim_mazurok/gapi.client.displayvideo-v4 0.0.20250709 → 0.0.20250803
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 +356 -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: 20250803
|
|
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[];
|
|
@@ -1139,6 +1151,8 @@ declare namespace gapi.client {
|
|
|
1139
1151
|
partnerId?: string;
|
|
1140
1152
|
/** The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor). */
|
|
1141
1153
|
sharedAdvertiserIds?: string[];
|
|
1154
|
+
/** Optional. Immutable. Designates the third party optimization partner that manages this algorithm. */
|
|
1155
|
+
thirdPartyOptimizationPartner?: string;
|
|
1142
1156
|
}
|
|
1143
1157
|
interface CustomBiddingAlgorithmRules {
|
|
1144
1158
|
/** Output only. Whether the rules resource is currently being used for scoring by the parent algorithm. */
|
|
@@ -2055,6 +2069,12 @@ declare namespace gapi.client {
|
|
|
2055
2069
|
/** 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
2070
|
nextPageToken?: string;
|
|
2057
2071
|
}
|
|
2072
|
+
interface ListCampaignAssignedTargetingOptionsResponse {
|
|
2073
|
+
/** The list of assigned targeting options. This list will be absent if empty. */
|
|
2074
|
+
assignedTargetingOptions?: AssignedTargetingOption[];
|
|
2075
|
+
/** 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. */
|
|
2076
|
+
nextPageToken?: string;
|
|
2077
|
+
}
|
|
2058
2078
|
interface ListCampaignsResponse {
|
|
2059
2079
|
/** The list of campaigns. This list will be absent if empty. */
|
|
2060
2080
|
campaigns?: Campaign[];
|
|
@@ -2127,6 +2147,12 @@ declare namespace gapi.client {
|
|
|
2127
2147
|
/** 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
2148
|
nextPageToken?: string;
|
|
2129
2149
|
}
|
|
2150
|
+
interface ListInsertionOrderAssignedTargetingOptionsResponse {
|
|
2151
|
+
/** The list of assigned targeting options. This list will be absent if empty. */
|
|
2152
|
+
assignedTargetingOptions?: AssignedTargetingOption[];
|
|
2153
|
+
/** 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. */
|
|
2154
|
+
nextPageToken?: string;
|
|
2155
|
+
}
|
|
2130
2156
|
interface ListInsertionOrdersResponse {
|
|
2131
2157
|
/** The list of insertion orders. This list will be absent if empty. */
|
|
2132
2158
|
insertionOrders?: InsertionOrder[];
|
|
@@ -3344,6 +3370,83 @@ declare namespace gapi.client {
|
|
|
3344
3370
|
body: CreateAssetRequest,
|
|
3345
3371
|
): Request<CreateAssetResponse>;
|
|
3346
3372
|
}
|
|
3373
|
+
interface AssignedTargetingOptionsResource {
|
|
3374
|
+
/** Gets a single targeting option assigned to a campaign. */
|
|
3375
|
+
get(request?: {
|
|
3376
|
+
/** V1 error format. */
|
|
3377
|
+
'$.xgafv'?: string;
|
|
3378
|
+
/** OAuth access token. */
|
|
3379
|
+
access_token?: string;
|
|
3380
|
+
/** Required. The ID of the advertiser the campaign belongs to. */
|
|
3381
|
+
advertiserId: string;
|
|
3382
|
+
/** Data format for response. */
|
|
3383
|
+
alt?: string;
|
|
3384
|
+
/** Required. An identifier unique to the targeting type in this campaign that identifies the assigned targeting option being requested. */
|
|
3385
|
+
assignedTargetingOptionId: string;
|
|
3386
|
+
/** JSONP */
|
|
3387
|
+
callback?: string;
|
|
3388
|
+
/** Required. The ID of the campaign the assigned targeting option belongs to. */
|
|
3389
|
+
campaignId: string;
|
|
3390
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3391
|
+
fields?: string;
|
|
3392
|
+
/** 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. */
|
|
3393
|
+
key?: string;
|
|
3394
|
+
/** OAuth 2.0 token for the current user. */
|
|
3395
|
+
oauth_token?: string;
|
|
3396
|
+
/** Returns response with indentations and line breaks. */
|
|
3397
|
+
prettyPrint?: boolean;
|
|
3398
|
+
/** 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. */
|
|
3399
|
+
quotaUser?: string;
|
|
3400
|
+
/** 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` */
|
|
3401
|
+
targetingType: string;
|
|
3402
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3403
|
+
upload_protocol?: string;
|
|
3404
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3405
|
+
uploadType?: string;
|
|
3406
|
+
}): Request<AssignedTargetingOption>;
|
|
3407
|
+
/** Lists the targeting options assigned to a campaign for a specified targeting type. */
|
|
3408
|
+
list(request?: {
|
|
3409
|
+
/** V1 error format. */
|
|
3410
|
+
'$.xgafv'?: string;
|
|
3411
|
+
/** OAuth access token. */
|
|
3412
|
+
access_token?: string;
|
|
3413
|
+
/** Required. The ID of the advertiser the campaign belongs to. */
|
|
3414
|
+
advertiserId: string;
|
|
3415
|
+
/** Data format for response. */
|
|
3416
|
+
alt?: string;
|
|
3417
|
+
/** JSONP */
|
|
3418
|
+
callback?: string;
|
|
3419
|
+
/** Required. The ID of the campaign to list assigned targeting options for. */
|
|
3420
|
+
campaignId: string;
|
|
3421
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3422
|
+
fields?: string;
|
|
3423
|
+
/** 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. */
|
|
3424
|
+
filter?: string;
|
|
3425
|
+
/** 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. */
|
|
3426
|
+
key?: string;
|
|
3427
|
+
/** OAuth 2.0 token for the current user. */
|
|
3428
|
+
oauth_token?: string;
|
|
3429
|
+
/** 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`. */
|
|
3430
|
+
orderBy?: string;
|
|
3431
|
+
/** 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. */
|
|
3432
|
+
pageSize?: number;
|
|
3433
|
+
/** 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. */
|
|
3434
|
+
pageToken?: string;
|
|
3435
|
+
/** Returns response with indentations and line breaks. */
|
|
3436
|
+
prettyPrint?: boolean;
|
|
3437
|
+
/** 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. */
|
|
3438
|
+
quotaUser?: string;
|
|
3439
|
+
/** 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` */
|
|
3440
|
+
targetingType: string;
|
|
3441
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3442
|
+
upload_protocol?: string;
|
|
3443
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3444
|
+
uploadType?: string;
|
|
3445
|
+
}): Request<ListCampaignAssignedTargetingOptionsResponse>;
|
|
3446
|
+
}
|
|
3447
|
+
interface TargetingTypesResource {
|
|
3448
|
+
assignedTargetingOptions: AssignedTargetingOptionsResource;
|
|
3449
|
+
}
|
|
3347
3450
|
interface CampaignsResource {
|
|
3348
3451
|
/** Creates a new campaign. Returns the newly created campaign if successful. */
|
|
3349
3452
|
create(request: {
|
|
@@ -3496,6 +3599,43 @@ declare namespace gapi.client {
|
|
|
3496
3599
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3497
3600
|
uploadType?: string;
|
|
3498
3601
|
}): Request<ListCampaignsResponse>;
|
|
3602
|
+
/** Lists assigned targeting options of a campaign across targeting types. */
|
|
3603
|
+
listAssignedTargetingOptions(request?: {
|
|
3604
|
+
/** V1 error format. */
|
|
3605
|
+
'$.xgafv'?: string;
|
|
3606
|
+
/** OAuth access token. */
|
|
3607
|
+
access_token?: string;
|
|
3608
|
+
/** Required. The ID of the advertiser the campaign belongs to. */
|
|
3609
|
+
advertiserId: string;
|
|
3610
|
+
/** Data format for response. */
|
|
3611
|
+
alt?: string;
|
|
3612
|
+
/** JSONP */
|
|
3613
|
+
callback?: string;
|
|
3614
|
+
/** Required. The ID of the campaign to list assigned targeting options for. */
|
|
3615
|
+
campaignId: string;
|
|
3616
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3617
|
+
fields?: string;
|
|
3618
|
+
/** 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. */
|
|
3619
|
+
filter?: string;
|
|
3620
|
+
/** 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. */
|
|
3621
|
+
key?: string;
|
|
3622
|
+
/** OAuth 2.0 token for the current user. */
|
|
3623
|
+
oauth_token?: string;
|
|
3624
|
+
/** 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`. */
|
|
3625
|
+
orderBy?: string;
|
|
3626
|
+
/** 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. */
|
|
3627
|
+
pageSize?: number;
|
|
3628
|
+
/** 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. */
|
|
3629
|
+
pageToken?: string;
|
|
3630
|
+
/** Returns response with indentations and line breaks. */
|
|
3631
|
+
prettyPrint?: boolean;
|
|
3632
|
+
/** 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. */
|
|
3633
|
+
quotaUser?: string;
|
|
3634
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3635
|
+
upload_protocol?: string;
|
|
3636
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3637
|
+
uploadType?: string;
|
|
3638
|
+
}): Request<BulkListCampaignAssignedTargetingOptionsResponse>;
|
|
3499
3639
|
/** Updates an existing campaign. Returns the updated campaign if successful. */
|
|
3500
3640
|
patch(request: {
|
|
3501
3641
|
/** V1 error format. */
|
|
@@ -3562,6 +3702,7 @@ declare namespace gapi.client {
|
|
|
3562
3702
|
},
|
|
3563
3703
|
body: Campaign,
|
|
3564
3704
|
): Request<Campaign>;
|
|
3705
|
+
targetingTypes: TargetingTypesResource;
|
|
3565
3706
|
}
|
|
3566
3707
|
interface SitesResource {
|
|
3567
3708
|
/** 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. */
|
|
@@ -4249,6 +4390,182 @@ declare namespace gapi.client {
|
|
|
4249
4390
|
body: Creative,
|
|
4250
4391
|
): Request<Creative>;
|
|
4251
4392
|
}
|
|
4393
|
+
interface AssignedTargetingOptionsResource {
|
|
4394
|
+
/** 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` */
|
|
4395
|
+
create(request: {
|
|
4396
|
+
/** V1 error format. */
|
|
4397
|
+
'$.xgafv'?: string;
|
|
4398
|
+
/** OAuth access token. */
|
|
4399
|
+
access_token?: string;
|
|
4400
|
+
/** Required. The ID of the advertiser the insertion order belongs to. */
|
|
4401
|
+
advertiserId: string;
|
|
4402
|
+
/** Data format for response. */
|
|
4403
|
+
alt?: string;
|
|
4404
|
+
/** JSONP */
|
|
4405
|
+
callback?: string;
|
|
4406
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4407
|
+
fields?: string;
|
|
4408
|
+
/** Required. The ID of the insertion order the assigned targeting option will belong to. */
|
|
4409
|
+
insertionOrderId: string;
|
|
4410
|
+
/** 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. */
|
|
4411
|
+
key?: string;
|
|
4412
|
+
/** OAuth 2.0 token for the current user. */
|
|
4413
|
+
oauth_token?: string;
|
|
4414
|
+
/** Returns response with indentations and line breaks. */
|
|
4415
|
+
prettyPrint?: boolean;
|
|
4416
|
+
/** 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. */
|
|
4417
|
+
quotaUser?: string;
|
|
4418
|
+
/** 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` */
|
|
4419
|
+
targetingType: string;
|
|
4420
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4421
|
+
upload_protocol?: string;
|
|
4422
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4423
|
+
uploadType?: string;
|
|
4424
|
+
/** Request body */
|
|
4425
|
+
resource: AssignedTargetingOption;
|
|
4426
|
+
}): Request<AssignedTargetingOption>;
|
|
4427
|
+
create(
|
|
4428
|
+
request: {
|
|
4429
|
+
/** V1 error format. */
|
|
4430
|
+
'$.xgafv'?: string;
|
|
4431
|
+
/** OAuth access token. */
|
|
4432
|
+
access_token?: string;
|
|
4433
|
+
/** Required. The ID of the advertiser the insertion order belongs to. */
|
|
4434
|
+
advertiserId: string;
|
|
4435
|
+
/** Data format for response. */
|
|
4436
|
+
alt?: string;
|
|
4437
|
+
/** JSONP */
|
|
4438
|
+
callback?: string;
|
|
4439
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4440
|
+
fields?: string;
|
|
4441
|
+
/** Required. The ID of the insertion order the assigned targeting option will belong to. */
|
|
4442
|
+
insertionOrderId: string;
|
|
4443
|
+
/** 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. */
|
|
4444
|
+
key?: string;
|
|
4445
|
+
/** OAuth 2.0 token for the current user. */
|
|
4446
|
+
oauth_token?: string;
|
|
4447
|
+
/** Returns response with indentations and line breaks. */
|
|
4448
|
+
prettyPrint?: boolean;
|
|
4449
|
+
/** 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. */
|
|
4450
|
+
quotaUser?: string;
|
|
4451
|
+
/** 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` */
|
|
4452
|
+
targetingType: string;
|
|
4453
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4454
|
+
upload_protocol?: string;
|
|
4455
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4456
|
+
uploadType?: string;
|
|
4457
|
+
},
|
|
4458
|
+
body: AssignedTargetingOption,
|
|
4459
|
+
): Request<AssignedTargetingOption>;
|
|
4460
|
+
/** 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` */
|
|
4461
|
+
delete(request?: {
|
|
4462
|
+
/** V1 error format. */
|
|
4463
|
+
'$.xgafv'?: string;
|
|
4464
|
+
/** OAuth access token. */
|
|
4465
|
+
access_token?: string;
|
|
4466
|
+
/** Required. The ID of the advertiser the insertion order belongs to. */
|
|
4467
|
+
advertiserId: string;
|
|
4468
|
+
/** Data format for response. */
|
|
4469
|
+
alt?: string;
|
|
4470
|
+
/** Required. The ID of the assigned targeting option to delete. */
|
|
4471
|
+
assignedTargetingOptionId: string;
|
|
4472
|
+
/** JSONP */
|
|
4473
|
+
callback?: string;
|
|
4474
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4475
|
+
fields?: string;
|
|
4476
|
+
/** Required. The ID of the insertion order the assigned targeting option belongs to. */
|
|
4477
|
+
insertionOrderId: string;
|
|
4478
|
+
/** 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. */
|
|
4479
|
+
key?: string;
|
|
4480
|
+
/** OAuth 2.0 token for the current user. */
|
|
4481
|
+
oauth_token?: string;
|
|
4482
|
+
/** Returns response with indentations and line breaks. */
|
|
4483
|
+
prettyPrint?: boolean;
|
|
4484
|
+
/** 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. */
|
|
4485
|
+
quotaUser?: string;
|
|
4486
|
+
/** 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` */
|
|
4487
|
+
targetingType: string;
|
|
4488
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4489
|
+
upload_protocol?: string;
|
|
4490
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4491
|
+
uploadType?: string;
|
|
4492
|
+
}): Request<{}>;
|
|
4493
|
+
/** Gets a single targeting option assigned to an insertion order. */
|
|
4494
|
+
get(request?: {
|
|
4495
|
+
/** V1 error format. */
|
|
4496
|
+
'$.xgafv'?: string;
|
|
4497
|
+
/** OAuth access token. */
|
|
4498
|
+
access_token?: string;
|
|
4499
|
+
/** Required. The ID of the advertiser the insertion order belongs to. */
|
|
4500
|
+
advertiserId: string;
|
|
4501
|
+
/** Data format for response. */
|
|
4502
|
+
alt?: string;
|
|
4503
|
+
/** Required. An identifier unique to the targeting type in this insertion order that identifies the assigned targeting option being requested. */
|
|
4504
|
+
assignedTargetingOptionId: string;
|
|
4505
|
+
/** JSONP */
|
|
4506
|
+
callback?: string;
|
|
4507
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4508
|
+
fields?: string;
|
|
4509
|
+
/** Required. The ID of the insertion order the assigned targeting option belongs to. */
|
|
4510
|
+
insertionOrderId: string;
|
|
4511
|
+
/** 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. */
|
|
4512
|
+
key?: string;
|
|
4513
|
+
/** OAuth 2.0 token for the current user. */
|
|
4514
|
+
oauth_token?: string;
|
|
4515
|
+
/** Returns response with indentations and line breaks. */
|
|
4516
|
+
prettyPrint?: boolean;
|
|
4517
|
+
/** 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. */
|
|
4518
|
+
quotaUser?: string;
|
|
4519
|
+
/** 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` */
|
|
4520
|
+
targetingType: string;
|
|
4521
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4522
|
+
upload_protocol?: string;
|
|
4523
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4524
|
+
uploadType?: string;
|
|
4525
|
+
}): Request<AssignedTargetingOption>;
|
|
4526
|
+
/** Lists the targeting options assigned to an insertion order. */
|
|
4527
|
+
list(request?: {
|
|
4528
|
+
/** V1 error format. */
|
|
4529
|
+
'$.xgafv'?: string;
|
|
4530
|
+
/** OAuth access token. */
|
|
4531
|
+
access_token?: string;
|
|
4532
|
+
/** Required. The ID of the advertiser the insertion order belongs to. */
|
|
4533
|
+
advertiserId: string;
|
|
4534
|
+
/** Data format for response. */
|
|
4535
|
+
alt?: string;
|
|
4536
|
+
/** JSONP */
|
|
4537
|
+
callback?: string;
|
|
4538
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4539
|
+
fields?: string;
|
|
4540
|
+
/** 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. */
|
|
4541
|
+
filter?: string;
|
|
4542
|
+
/** Required. The ID of the insertion order to list assigned targeting options for. */
|
|
4543
|
+
insertionOrderId: string;
|
|
4544
|
+
/** 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. */
|
|
4545
|
+
key?: string;
|
|
4546
|
+
/** OAuth 2.0 token for the current user. */
|
|
4547
|
+
oauth_token?: string;
|
|
4548
|
+
/** 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`. */
|
|
4549
|
+
orderBy?: string;
|
|
4550
|
+
/** 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. */
|
|
4551
|
+
pageSize?: number;
|
|
4552
|
+
/** 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. */
|
|
4553
|
+
pageToken?: string;
|
|
4554
|
+
/** Returns response with indentations and line breaks. */
|
|
4555
|
+
prettyPrint?: boolean;
|
|
4556
|
+
/** 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. */
|
|
4557
|
+
quotaUser?: string;
|
|
4558
|
+
/** 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` */
|
|
4559
|
+
targetingType: string;
|
|
4560
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4561
|
+
upload_protocol?: string;
|
|
4562
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4563
|
+
uploadType?: string;
|
|
4564
|
+
}): Request<ListInsertionOrderAssignedTargetingOptionsResponse>;
|
|
4565
|
+
}
|
|
4566
|
+
interface TargetingTypesResource {
|
|
4567
|
+
assignedTargetingOptions: AssignedTargetingOptionsResource;
|
|
4568
|
+
}
|
|
4252
4569
|
interface InsertionOrdersResource {
|
|
4253
4570
|
/** Creates a new insertion order. Returns the newly created insertion order if successful. */
|
|
4254
4571
|
create(request: {
|
|
@@ -4401,6 +4718,43 @@ declare namespace gapi.client {
|
|
|
4401
4718
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4402
4719
|
uploadType?: string;
|
|
4403
4720
|
}): Request<ListInsertionOrdersResponse>;
|
|
4721
|
+
/** Lists assigned targeting options of an insertion order across targeting types. */
|
|
4722
|
+
listAssignedTargetingOptions(request?: {
|
|
4723
|
+
/** V1 error format. */
|
|
4724
|
+
'$.xgafv'?: string;
|
|
4725
|
+
/** OAuth access token. */
|
|
4726
|
+
access_token?: string;
|
|
4727
|
+
/** Required. The ID of the advertiser the insertion order belongs to. */
|
|
4728
|
+
advertiserId: string;
|
|
4729
|
+
/** Data format for response. */
|
|
4730
|
+
alt?: string;
|
|
4731
|
+
/** JSONP */
|
|
4732
|
+
callback?: string;
|
|
4733
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4734
|
+
fields?: string;
|
|
4735
|
+
/** 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. */
|
|
4736
|
+
filter?: string;
|
|
4737
|
+
/** Required. The ID of the insertion order to list assigned targeting options for. */
|
|
4738
|
+
insertionOrderId: string;
|
|
4739
|
+
/** 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. */
|
|
4740
|
+
key?: string;
|
|
4741
|
+
/** OAuth 2.0 token for the current user. */
|
|
4742
|
+
oauth_token?: string;
|
|
4743
|
+
/** 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`. */
|
|
4744
|
+
orderBy?: string;
|
|
4745
|
+
/** 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. */
|
|
4746
|
+
pageSize?: number;
|
|
4747
|
+
/** 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. */
|
|
4748
|
+
pageToken?: string;
|
|
4749
|
+
/** Returns response with indentations and line breaks. */
|
|
4750
|
+
prettyPrint?: boolean;
|
|
4751
|
+
/** 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. */
|
|
4752
|
+
quotaUser?: string;
|
|
4753
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4754
|
+
upload_protocol?: string;
|
|
4755
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4756
|
+
uploadType?: string;
|
|
4757
|
+
}): Request<BulkListInsertionOrderAssignedTargetingOptionsResponse>;
|
|
4404
4758
|
/** Updates an existing insertion order. Returns the updated insertion order if successful. */
|
|
4405
4759
|
patch(request: {
|
|
4406
4760
|
/** V1 error format. */
|
|
@@ -4467,6 +4821,7 @@ declare namespace gapi.client {
|
|
|
4467
4821
|
},
|
|
4468
4822
|
body: InsertionOrder,
|
|
4469
4823
|
): Request<InsertionOrder>;
|
|
4824
|
+
targetingTypes: TargetingTypesResource;
|
|
4470
4825
|
}
|
|
4471
4826
|
interface InvoicesResource {
|
|
4472
4827
|
/** 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. */
|