Skip to content

Commit 8306819

Browse files
feat(displayvideo): update the api
#### displayvideo:v2 The following keys were added: - resources.advertisers.resources.youtubeAdGroupAds.methods.get (Total Keys: 17) - resources.advertisers.resources.youtubeAdGroupAds.methods.list (Total Keys: 21) - resources.advertisers.resources.youtubeAdGroups.methods.bulkListAdGroupAssignedTargetingOptions (Total Keys: 25) - resources.advertisers.resources.youtubeAdGroups.methods.get (Total Keys: 17) - resources.advertisers.resources.youtubeAdGroups.methods.list (Total Keys: 21) - resources.advertisers.resources.youtubeAdGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get (Total Keys: 25) - resources.advertisers.resources.youtubeAdGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list (Total Keys: 30) - schemas.AssignedTargetingOption.properties.sessionPositionDetails.$ref (Total Keys: 1) - schemas.AssignedTargetingOption.properties.youtubeChannelDetails.$ref (Total Keys: 1) - schemas.AssignedTargetingOption.properties.youtubeVideoDetails.$ref (Total Keys: 1) - schemas.AudioAd (Total Keys: 3) - schemas.BulkListAdGroupAssignedTargetingOptionsResponse (Total Keys: 5) - schemas.BumperAd (Total Keys: 3) - schemas.CommonInStreamAttribute (Total Keys: 6) - schemas.CustomLabel (Total Keys: 4) - schemas.DisplayVideoSourceAd (Total Keys: 4) - schemas.ImageAsset (Total Keys: 6) - schemas.InStreamAd (Total Keys: 5) - schemas.ListYoutubeAdGroupAdsResponse (Total Keys: 5) - schemas.ListYoutubeAdGroupAssignedTargetingOptionsResponse (Total Keys: 5) - schemas.ListYoutubeAdGroupsResponse (Total Keys: 5) - schemas.MastheadAd (Total Keys: 13) - schemas.NonSkippableAd (Total Keys: 5) - schemas.ProductFeedData (Total Keys: 6) - schemas.ProductMatchDimension (Total Keys: 4) - schemas.SessionPositionAssignedTargetingOptionDetails (Total Keys: 3) - schemas.TargetFrequency (Total Keys: 7) - schemas.VideoDiscoveryAd (Total Keys: 5) - schemas.VideoPerformanceAd (Total Keys: 15) - schemas.YoutubeAdGroup (Total Keys: 42) - schemas.YoutubeAndPartnersBiddingStrategy.properties.adGroupEffectiveTargetCpaSource (Total Keys: 2) - schemas.YoutubeAndPartnersBiddingStrategy.properties.adGroupEffectiveTargetCpaValue (Total Keys: 3) - schemas.YoutubeAndPartnersSettings.properties.leadFormId (Total Keys: 2) - schemas.YoutubeAndPartnersSettings.properties.linkedMerchantId (Total Keys: 2) - schemas.YoutubeAndPartnersSettings.properties.relatedVideoIds (Total Keys: 2) - schemas.YoutubeAndPartnersSettings.properties.targetFrequency.$ref (Total Keys: 1) - schemas.YoutubeChannelAssignedTargetingOptionDetails (Total Keys: 4) - schemas.YoutubeVideoAssignedTargetingOptionDetails (Total Keys: 4) - schemas.YoutubeVideoDetails (Total Keys: 4)
1 parent f619e45 commit 8306819

17 files changed

+4098
-56
lines changed

docs/dyn/displayvideo_v2.advertisers.campaigns.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -711,6 +711,9 @@ <h3>Method Details</h3>
711711
&quot;sensitiveCategoryExclusionDetails&quot;: { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren&#x27;t visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can&#x27;t override them.
712712
&quot;excludedSensitiveCategory&quot;: &quot;A String&quot;, # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
713713
},
714+
&quot;sessionPositionDetails&quot;: { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
715+
&quot;sessionPosition&quot;: &quot;A String&quot;, # The position where the ad will show in a session.
716+
},
714717
&quot;subExchangeDetails&quot;: { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
715718
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
716719
},
@@ -786,6 +789,14 @@ <h3>Method Details</h3>
786789
&quot;viewabilityDetails&quot;: { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
787790
&quot;viewability&quot;: &quot;A String&quot;, # The predicted viewability percentage. Output only in v1. Required in v2.
788791
},
792+
&quot;youtubeChannelDetails&quot;: { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
793+
&quot;channelId&quot;: &quot;A String&quot;, # The YouTube uploader channel id or the channel code of a YouTube channel.
794+
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
795+
},
796+
&quot;youtubeVideoDetails&quot;: { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
797+
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
798+
&quot;videoId&quot;: &quot;A String&quot;, # YouTube video id as it appears on the YouTube watch page.
799+
},
789800
},
790801
],
791802
&quot;nextPageToken&quot;: &quot;A String&quot;, # 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.

docs/dyn/displayvideo_v2.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,9 @@ <h3>Method Details</h3>
147147
TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
148148
TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
149149
TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
150+
TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video.
151+
TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel.
152+
TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
150153
assignedTargetingOptionId: string, Required. An identifier unique to the targeting type in this campaign that identifies the assigned targeting option being requested. (required)
151154
x__xgafv: string, V1 error format.
152155
Allowed values
@@ -369,6 +372,9 @@ <h3>Method Details</h3>
369372
&quot;sensitiveCategoryExclusionDetails&quot;: { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren&#x27;t visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can&#x27;t override them.
370373
&quot;excludedSensitiveCategory&quot;: &quot;A String&quot;, # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
371374
},
375+
&quot;sessionPositionDetails&quot;: { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
376+
&quot;sessionPosition&quot;: &quot;A String&quot;, # The position where the ad will show in a session.
377+
},
372378
&quot;subExchangeDetails&quot;: { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
373379
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
374380
},
@@ -444,6 +450,14 @@ <h3>Method Details</h3>
444450
&quot;viewabilityDetails&quot;: { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
445451
&quot;viewability&quot;: &quot;A String&quot;, # The predicted viewability percentage. Output only in v1. Required in v2.
446452
},
453+
&quot;youtubeChannelDetails&quot;: { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
454+
&quot;channelId&quot;: &quot;A String&quot;, # The YouTube uploader channel id or the channel code of a YouTube channel.
455+
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
456+
},
457+
&quot;youtubeVideoDetails&quot;: { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
458+
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
459+
&quot;videoId&quot;: &quot;A String&quot;, # YouTube video id as it appears on the YouTube watch page.
460+
},
447461
}</pre>
448462
</div>
449463

@@ -502,6 +516,9 @@ <h3>Method Details</h3>
502516
TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
503517
TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
504518
TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
519+
TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video.
520+
TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel.
521+
TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
505522
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`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` - `inheritance` Examples: * AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId=&quot;1&quot; OR assignedTargetingOptionId=&quot;2&quot;` * AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance=&quot;NOT_INHERITED&quot; OR inheritance=&quot;INHERITED_FROM_PARTNER&quot;` The length of this field should be no more than 500 characters.
506523
orderBy: string, 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 &quot;desc&quot; should be added to the field name. Example: `assignedTargetingOptionId desc`.
507524
pageSize: integer, 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.
@@ -729,6 +746,9 @@ <h3>Method Details</h3>
729746
&quot;sensitiveCategoryExclusionDetails&quot;: { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren&#x27;t visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can&#x27;t override them.
730747
&quot;excludedSensitiveCategory&quot;: &quot;A String&quot;, # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
731748
},
749+
&quot;sessionPositionDetails&quot;: { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
750+
&quot;sessionPosition&quot;: &quot;A String&quot;, # The position where the ad will show in a session.
751+
},
732752
&quot;subExchangeDetails&quot;: { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
733753
&quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
734754
},
@@ -804,6 +824,14 @@ <h3>Method Details</h3>
804824
&quot;viewabilityDetails&quot;: { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
805825
&quot;viewability&quot;: &quot;A String&quot;, # The predicted viewability percentage. Output only in v1. Required in v2.
806826
},
827+
&quot;youtubeChannelDetails&quot;: { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
828+
&quot;channelId&quot;: &quot;A String&quot;, # The YouTube uploader channel id or the channel code of a YouTube channel.
829+
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
830+
},
831+
&quot;youtubeVideoDetails&quot;: { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
832+
&quot;negative&quot;: True or False, # Indicates if this option is being negatively targeted.
833+
&quot;videoId&quot;: &quot;A String&quot;, # YouTube video id as it appears on the YouTube watch page.
834+
},
807835
},
808836
],
809837
&quot;nextPageToken&quot;: &quot;A String&quot;, # 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.

0 commit comments

Comments
 (0)