docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/displayvideo_v1.advertisers.campaigns.html b/docs/dyn/displayvideo_v1.advertisers.campaigns.html
index 5c4ebbb..1cf8f94 100644
--- a/docs/dyn/displayvideo_v1.advertisers.campaigns.html
+++ b/docs/dyn/displayvideo_v1.advertisers.campaigns.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(advertiserId, campaignId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a campaign.</p>
<p class="toc_element">
- <code><a href="#list">list(advertiserId, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(advertiserId, pageSize=None, filter=None, pageToken=None, orderBy=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists campaigns in an advertiser.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -164,6 +164,12 @@
},
"frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency cap setting of the campaign.
# ad during a given time period.
+ "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
+ # `true`, the remaining frequency cap fields are not applicable.
+ "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
+ # during this period. Must be greater than 0.
+ #
+ # Applicable when unlimited is `false`.
"timeUnit": "A String", # The time unit in which the frequency cap will be applied.
#
# Applicable when unlimited is `false`.
@@ -181,12 +187,6 @@
# * `TIME_UNIT_DAYS` - must be between 1 and 6
# * `TIME_UNIT_HOURS` - must be between 1 and 23
# * `TIME_UNIT_MINUTES` - must be between 1 and 59
- "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
- # `true`, the remaining frequency cap fields are not applicable.
- "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
- # during this period. Must be greater than 0.
- #
- # Applicable when unlimited is `false`.
},
"displayName": "A String", # Required. The display name of the campaign.
#
@@ -201,6 +201,8 @@
# `ENTITY_STATUS_ARCHIVED` is not allowed.
"updateTime": "A String", # Output only. The timestamp when the campaign was last updated. Assigned by the system.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to.
+ "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
+ "name": "A String", # Output only. The resource name of the campaign.
"campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign.
#
@@ -214,7 +216,6 @@
# * `PERFORMANCE_GOAL_TYPE_CTR`
# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`
# * `PERFORMANCE_GOAL_TYPE_OTHER`
- "performanceGoalType": "A String", # Required. The type of the performance goal.
"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.
#
# Applicable when
@@ -241,11 +242,10 @@
# Applicable when
# performance_goal_type is set to
# `PERFORMANCE_GOAL_TYPE_OTHER`.
+ "performanceGoalType": "A String", # Required. The type of the performance goal.
},
"campaignGoalType": "A String", # Required. The type of the campaign goal.
},
- "name": "A String", # Output only. The resource name of the campaign.
- "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
}
x__xgafv: string, V1 error format.
@@ -317,6 +317,12 @@
},
"frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency cap setting of the campaign.
# ad during a given time period.
+ "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
+ # `true`, the remaining frequency cap fields are not applicable.
+ "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
+ # during this period. Must be greater than 0.
+ #
+ # Applicable when unlimited is `false`.
"timeUnit": "A String", # The time unit in which the frequency cap will be applied.
#
# Applicable when unlimited is `false`.
@@ -334,12 +340,6 @@
# * `TIME_UNIT_DAYS` - must be between 1 and 6
# * `TIME_UNIT_HOURS` - must be between 1 and 23
# * `TIME_UNIT_MINUTES` - must be between 1 and 59
- "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
- # `true`, the remaining frequency cap fields are not applicable.
- "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
- # during this period. Must be greater than 0.
- #
- # Applicable when unlimited is `false`.
},
"displayName": "A String", # Required. The display name of the campaign.
#
@@ -354,6 +354,8 @@
# `ENTITY_STATUS_ARCHIVED` is not allowed.
"updateTime": "A String", # Output only. The timestamp when the campaign was last updated. Assigned by the system.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to.
+ "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
+ "name": "A String", # Output only. The resource name of the campaign.
"campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign.
#
@@ -367,7 +369,6 @@
# * `PERFORMANCE_GOAL_TYPE_CTR`
# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`
# * `PERFORMANCE_GOAL_TYPE_OTHER`
- "performanceGoalType": "A String", # Required. The type of the performance goal.
"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.
#
# Applicable when
@@ -394,11 +395,10 @@
# Applicable when
# performance_goal_type is set to
# `PERFORMANCE_GOAL_TYPE_OTHER`.
+ "performanceGoalType": "A String", # Required. The type of the performance goal.
},
"campaignGoalType": "A String", # Required. The type of the campaign goal.
},
- "name": "A String", # Output only. The resource name of the campaign.
- "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
}</pre>
</div>
@@ -508,6 +508,12 @@
},
"frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency cap setting of the campaign.
# ad during a given time period.
+ "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
+ # `true`, the remaining frequency cap fields are not applicable.
+ "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
+ # during this period. Must be greater than 0.
+ #
+ # Applicable when unlimited is `false`.
"timeUnit": "A String", # The time unit in which the frequency cap will be applied.
#
# Applicable when unlimited is `false`.
@@ -525,12 +531,6 @@
# * `TIME_UNIT_DAYS` - must be between 1 and 6
# * `TIME_UNIT_HOURS` - must be between 1 and 23
# * `TIME_UNIT_MINUTES` - must be between 1 and 59
- "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
- # `true`, the remaining frequency cap fields are not applicable.
- "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
- # during this period. Must be greater than 0.
- #
- # Applicable when unlimited is `false`.
},
"displayName": "A String", # Required. The display name of the campaign.
#
@@ -545,6 +545,8 @@
# `ENTITY_STATUS_ARCHIVED` is not allowed.
"updateTime": "A String", # Output only. The timestamp when the campaign was last updated. Assigned by the system.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to.
+ "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
+ "name": "A String", # Output only. The resource name of the campaign.
"campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign.
#
@@ -558,7 +560,6 @@
# * `PERFORMANCE_GOAL_TYPE_CTR`
# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`
# * `PERFORMANCE_GOAL_TYPE_OTHER`
- "performanceGoalType": "A String", # Required. The type of the performance goal.
"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.
#
# Applicable when
@@ -585,16 +586,15 @@
# Applicable when
# performance_goal_type is set to
# `PERFORMANCE_GOAL_TYPE_OTHER`.
+ "performanceGoalType": "A String", # Required. The type of the performance goal.
},
"campaignGoalType": "A String", # Required. The type of the campaign goal.
},
- "name": "A String", # Output only. The resource name of the campaign.
- "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(advertiserId, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(advertiserId, pageSize=None, filter=None, pageToken=None, orderBy=None, x__xgafv=None)</code>
<pre>Lists campaigns in an advertiser.
The order is defined by the order_by
@@ -605,20 +605,6 @@
Args:
advertiserId: string, The ID of the advertiser to list campaigns for. (required)
- pageToken: string, 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 `ListCampaigns` method. If not specified, the first page
-of results will be returned.
- orderBy: string, Field by which to sort the list.
-Acceptable values are:
-
-* `displayName` (default)
-* `entityStatus`
-
-The default sorting order is ascending. To specify descending order for
-a field, a suffix "desc" should be added to the field name. Example:
-`displayName desc`.
pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will
default to `100`.
filter: string, Allows filtering by campaign properties.
@@ -641,6 +627,20 @@
entityStatus="ENTITY_STATUS_PAUSED")`
The length of this field should be no more than 500 characters.
+ pageToken: string, 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 `ListCampaigns` method. If not specified, the first page
+of results will be returned.
+ orderBy: string, Field by which to sort the list.
+Acceptable values are:
+
+* `displayName` (default)
+* `entityStatus`
+
+The default sorting order is ascending. To specify descending order for
+a field, a suffix "desc" should be added to the field name. Example:
+`displayName desc`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -714,6 +714,12 @@
},
"frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency cap setting of the campaign.
# ad during a given time period.
+ "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
+ # `true`, the remaining frequency cap fields are not applicable.
+ "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
+ # during this period. Must be greater than 0.
+ #
+ # Applicable when unlimited is `false`.
"timeUnit": "A String", # The time unit in which the frequency cap will be applied.
#
# Applicable when unlimited is `false`.
@@ -731,12 +737,6 @@
# * `TIME_UNIT_DAYS` - must be between 1 and 6
# * `TIME_UNIT_HOURS` - must be between 1 and 23
# * `TIME_UNIT_MINUTES` - must be between 1 and 59
- "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
- # `true`, the remaining frequency cap fields are not applicable.
- "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
- # during this period. Must be greater than 0.
- #
- # Applicable when unlimited is `false`.
},
"displayName": "A String", # Required. The display name of the campaign.
#
@@ -751,6 +751,8 @@
# `ENTITY_STATUS_ARCHIVED` is not allowed.
"updateTime": "A String", # Output only. The timestamp when the campaign was last updated. Assigned by the system.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to.
+ "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
+ "name": "A String", # Output only. The resource name of the campaign.
"campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign.
#
@@ -764,7 +766,6 @@
# * `PERFORMANCE_GOAL_TYPE_CTR`
# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`
# * `PERFORMANCE_GOAL_TYPE_OTHER`
- "performanceGoalType": "A String", # Required. The type of the performance goal.
"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.
#
# Applicable when
@@ -791,11 +792,10 @@
# Applicable when
# performance_goal_type is set to
# `PERFORMANCE_GOAL_TYPE_OTHER`.
+ "performanceGoalType": "A String", # Required. The type of the performance goal.
},
"campaignGoalType": "A String", # Required. The type of the campaign goal.
},
- "name": "A String", # Output only. The resource name of the campaign.
- "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results.
@@ -891,6 +891,12 @@
},
"frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency cap setting of the campaign.
# ad during a given time period.
+ "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
+ # `true`, the remaining frequency cap fields are not applicable.
+ "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
+ # during this period. Must be greater than 0.
+ #
+ # Applicable when unlimited is `false`.
"timeUnit": "A String", # The time unit in which the frequency cap will be applied.
#
# Applicable when unlimited is `false`.
@@ -908,12 +914,6 @@
# * `TIME_UNIT_DAYS` - must be between 1 and 6
# * `TIME_UNIT_HOURS` - must be between 1 and 23
# * `TIME_UNIT_MINUTES` - must be between 1 and 59
- "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
- # `true`, the remaining frequency cap fields are not applicable.
- "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
- # during this period. Must be greater than 0.
- #
- # Applicable when unlimited is `false`.
},
"displayName": "A String", # Required. The display name of the campaign.
#
@@ -928,6 +928,8 @@
# `ENTITY_STATUS_ARCHIVED` is not allowed.
"updateTime": "A String", # Output only. The timestamp when the campaign was last updated. Assigned by the system.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to.
+ "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
+ "name": "A String", # Output only. The resource name of the campaign.
"campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign.
#
@@ -941,7 +943,6 @@
# * `PERFORMANCE_GOAL_TYPE_CTR`
# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`
# * `PERFORMANCE_GOAL_TYPE_OTHER`
- "performanceGoalType": "A String", # Required. The type of the performance goal.
"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.
#
# Applicable when
@@ -968,11 +969,10 @@
# Applicable when
# performance_goal_type is set to
# `PERFORMANCE_GOAL_TYPE_OTHER`.
+ "performanceGoalType": "A String", # Required. The type of the performance goal.
},
"campaignGoalType": "A String", # Required. The type of the campaign goal.
},
- "name": "A String", # Output only. The resource name of the campaign.
- "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
}
updateMask: string, Required. The mask to control which fields to update.
@@ -1045,6 +1045,12 @@
},
"frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency cap setting of the campaign.
# ad during a given time period.
+ "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
+ # `true`, the remaining frequency cap fields are not applicable.
+ "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
+ # during this period. Must be greater than 0.
+ #
+ # Applicable when unlimited is `false`.
"timeUnit": "A String", # The time unit in which the frequency cap will be applied.
#
# Applicable when unlimited is `false`.
@@ -1062,12 +1068,6 @@
# * `TIME_UNIT_DAYS` - must be between 1 and 6
# * `TIME_UNIT_HOURS` - must be between 1 and 23
# * `TIME_UNIT_MINUTES` - must be between 1 and 59
- "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
- # `true`, the remaining frequency cap fields are not applicable.
- "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
- # during this period. Must be greater than 0.
- #
- # Applicable when unlimited is `false`.
},
"displayName": "A String", # Required. The display name of the campaign.
#
@@ -1082,6 +1082,8 @@
# `ENTITY_STATUS_ARCHIVED` is not allowed.
"updateTime": "A String", # Output only. The timestamp when the campaign was last updated. Assigned by the system.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to.
+ "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
+ "name": "A String", # Output only. The resource name of the campaign.
"campaignGoal": { # Settings that control the goal of a campaign. # Required. The goal of the campaign.
"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. The performance goal of the campaign.
#
@@ -1095,7 +1097,6 @@
# * `PERFORMANCE_GOAL_TYPE_CTR`
# * `PERFORMANCE_GOAL_TYPE_VIEWABILITY`
# * `PERFORMANCE_GOAL_TYPE_OTHER`
- "performanceGoalType": "A String", # Required. The type of the performance goal.
"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.
#
# Applicable when
@@ -1122,11 +1123,10 @@
# Applicable when
# performance_goal_type is set to
# `PERFORMANCE_GOAL_TYPE_OTHER`.
+ "performanceGoalType": "A String", # Required. The type of the performance goal.
},
"campaignGoalType": "A String", # Required. The type of the campaign goal.
},
- "name": "A String", # Output only. The resource name of the campaign.
- "campaignId": "A String", # Output only. The unique ID of the campaign. Assigned by the system.
}</pre>
</div>