Skip to content

Commit

Permalink
feat(displayvideo): update the api
Browse files Browse the repository at this point in the history
#### displayvideo:v3

The following keys were added:
- schemas.Kpi.properties.kpiAlgorithmId (Total Keys: 2)
  • Loading branch information
yoshi-automation committed Apr 23, 2024
1 parent 4897b12 commit a5e88d2
Show file tree
Hide file tree
Showing 7 changed files with 41 additions and 18 deletions.
4 changes: 2 additions & 2 deletions docs/dyn/displayvideo_v2.advertisers.html
Expand Up @@ -366,7 +366,7 @@ <h3>Method Details</h3>
The object takes the form of:

{ # Request message for BulkEditAdvertiserAssignedTargetingOptions.
&quot;createRequests&quot;: [ # The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`
&quot;createRequests&quot;: [ # The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`
{ # A request listing which assigned targeting options of a given targeting type should be created and added.
&quot;assignedTargetingOptions&quot;: [ # Required. The assigned targeting options to create and add.
{ # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
Expand Down Expand Up @@ -673,7 +673,7 @@ <h3>Method Details</h3>
&quot;targetingType&quot;: &quot;A String&quot;, # Required. Identifies the type of this assigned targeting option.
},
],
&quot;deleteRequests&quot;: [ # The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`
&quot;deleteRequests&quot;: [ # The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`
{ # A request listing which assigned targeting options of a given targeting type should be deleted.
&quot;assignedTargetingOptionIds&quot;: [ # Required. The assigned targeting option IDs to delete.
&quot;A String&quot;,
Expand Down
Expand Up @@ -104,7 +104,7 @@ <h3>Method Details</h3>

Args:
advertiserId: string, Required. The ID of the advertiser. (required)
targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` (required)
targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` (required)
Allowed values
TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
Expand Down Expand Up @@ -775,7 +775,7 @@ <h3>Method Details</h3>

Args:
advertiserId: string, Required. The ID of the advertiser. (required)
targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` (required)
targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` (required)
Allowed values
TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
Expand Down
4 changes: 2 additions & 2 deletions docs/dyn/displayvideo_v3.advertisers.html
Expand Up @@ -361,7 +361,7 @@ <h3>Method Details</h3>
The object takes the form of:

{ # Request message for BulkEditAdvertiserAssignedTargetingOptions.
&quot;createRequests&quot;: [ # The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`
&quot;createRequests&quot;: [ # The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`
{ # A request listing which assigned targeting options of a given targeting type should be created and added.
&quot;assignedTargetingOptions&quot;: [ # Required. The assigned targeting options to create and add.
{ # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
Expand Down Expand Up @@ -668,7 +668,7 @@ <h3>Method Details</h3>
&quot;targetingType&quot;: &quot;A String&quot;, # Required. Identifies the type of this assigned targeting option.
},
],
&quot;deleteRequests&quot;: [ # The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`
&quot;deleteRequests&quot;: [ # The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`
{ # A request listing which assigned targeting options of a given targeting type should be deleted.
&quot;assignedTargetingOptionIds&quot;: [ # Required. The assigned targeting option IDs to delete.
&quot;A String&quot;,
Expand Down
6 changes: 6 additions & 0 deletions docs/dyn/displayvideo_v3.advertisers.insertionOrders.html
Expand Up @@ -186,6 +186,7 @@ <h3>Method Details</h3>
&quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
},
&quot;kpi&quot;: { # Settings that control the key performance indicator, or KPI, of an insertion order. # Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the &quot;Goal&quot; in the Display &amp; Video 360 interface.
&quot;kpiAlgorithmId&quot;: &quot;A String&quot;, # Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.
&quot;kpiAmountMicros&quot;: &quot;A String&quot;, # The goal amount, in micros of the advertiser&#x27;s currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency.
&quot;kpiPercentageMicros&quot;: &quot;A String&quot;, # The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07).
&quot;kpiString&quot;: &quot;A String&quot;, # A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`.
Expand Down Expand Up @@ -284,6 +285,7 @@ <h3>Method Details</h3>
&quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
},
&quot;kpi&quot;: { # Settings that control the key performance indicator, or KPI, of an insertion order. # Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the &quot;Goal&quot; in the Display &amp; Video 360 interface.
&quot;kpiAlgorithmId&quot;: &quot;A String&quot;, # Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.
&quot;kpiAmountMicros&quot;: &quot;A String&quot;, # The goal amount, in micros of the advertiser&#x27;s currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency.
&quot;kpiPercentageMicros&quot;: &quot;A String&quot;, # The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07).
&quot;kpiString&quot;: &quot;A String&quot;, # A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`.
Expand Down Expand Up @@ -409,6 +411,7 @@ <h3>Method Details</h3>
&quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
},
&quot;kpi&quot;: { # Settings that control the key performance indicator, or KPI, of an insertion order. # Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the &quot;Goal&quot; in the Display &amp; Video 360 interface.
&quot;kpiAlgorithmId&quot;: &quot;A String&quot;, # Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.
&quot;kpiAmountMicros&quot;: &quot;A String&quot;, # The goal amount, in micros of the advertiser&#x27;s currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency.
&quot;kpiPercentageMicros&quot;: &quot;A String&quot;, # The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07).
&quot;kpiString&quot;: &quot;A String&quot;, # A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`.
Expand Down Expand Up @@ -520,6 +523,7 @@ <h3>Method Details</h3>
&quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
},
&quot;kpi&quot;: { # Settings that control the key performance indicator, or KPI, of an insertion order. # Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the &quot;Goal&quot; in the Display &amp; Video 360 interface.
&quot;kpiAlgorithmId&quot;: &quot;A String&quot;, # Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.
&quot;kpiAmountMicros&quot;: &quot;A String&quot;, # The goal amount, in micros of the advertiser&#x27;s currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency.
&quot;kpiPercentageMicros&quot;: &quot;A String&quot;, # The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07).
&quot;kpiString&quot;: &quot;A String&quot;, # A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`.
Expand Down Expand Up @@ -978,6 +982,7 @@ <h3>Method Details</h3>
&quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
},
&quot;kpi&quot;: { # Settings that control the key performance indicator, or KPI, of an insertion order. # Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the &quot;Goal&quot; in the Display &amp; Video 360 interface.
&quot;kpiAlgorithmId&quot;: &quot;A String&quot;, # Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.
&quot;kpiAmountMicros&quot;: &quot;A String&quot;, # The goal amount, in micros of the advertiser&#x27;s currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency.
&quot;kpiPercentageMicros&quot;: &quot;A String&quot;, # The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07).
&quot;kpiString&quot;: &quot;A String&quot;, # A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`.
Expand Down Expand Up @@ -1077,6 +1082,7 @@ <h3>Method Details</h3>
&quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
},
&quot;kpi&quot;: { # Settings that control the key performance indicator, or KPI, of an insertion order. # Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the &quot;Goal&quot; in the Display &amp; Video 360 interface.
&quot;kpiAlgorithmId&quot;: &quot;A String&quot;, # Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.
&quot;kpiAmountMicros&quot;: &quot;A String&quot;, # The goal amount, in micros of the advertiser&#x27;s currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency.
&quot;kpiPercentageMicros&quot;: &quot;A String&quot;, # The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07).
&quot;kpiString&quot;: &quot;A String&quot;, # A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`.
Expand Down
Expand Up @@ -104,7 +104,7 @@ <h3>Method Details</h3>

Args:
advertiserId: string, Required. The ID of the advertiser. (required)
targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` (required)
targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` (required)
Allowed values
TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
Expand Down Expand Up @@ -775,7 +775,7 @@ <h3>Method Details</h3>

Args:
advertiserId: string, Required. The ID of the advertiser. (required)
targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` (required)
targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` (required)
Allowed values
TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
Expand Down

0 comments on commit a5e88d2

Please sign in to comment.