@google-ads/admanager

{ "nested": { "google": { "nested": { "ads": { "nested": { "admanager": { "nested": { "v1": { "options": { "csharp_namespace": "Google.Ads.AdManager.V1", "go_package": "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager", "java_multiple_files": true, "java_outer_classname": "UserServiceProto", "java_package": "com.google.ads.admanager.v1", "php_namespace": "Google\\Ads\\AdManager\\V1", "ruby_package": "Google::Ads::AdManager::V1" }, "nested": { "AdBreak": { "options": { "(google.api.resource).type": "admanager.googleapis.com/AdBreak", "(google.api.resource).pattern": "networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}", "(google.api.resource).plural": "adBreaks", "(google.api.resource).singular": "adBreak" }, "oneofs": { "_adBreakId": { "oneof": [ "adBreakId" ] }, "_assetKey": { "oneof": [ "assetKey" ] }, "_customAssetKey": { "oneof": [ "customAssetKey" ] }, "_expectedStartTime": { "oneof": [ "expectedStartTime" ] }, "_duration": { "oneof": [ "duration" ] }, "_breakState": { "oneof": [ "breakState" ] }, "_breakSequence": { "oneof": [ "breakSequence" ] }, "_podTemplateName": { "oneof": [ "podTemplateName" ] }, "_customParams": { "oneof": [ "customParams" ] }, "_scte_35CueOut": { "oneof": [ "scte_35CueOut" ] } }, "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "IDENTIFIER" } }, "adBreakId": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "IMMUTABLE", "proto3_optional": true } }, "assetKey": { "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "IMMUTABLE", "proto3_optional": true } }, "customAssetKey": { "type": "string", "id": 4, "options": { "(google.api.field_behavior)": "IMMUTABLE", "proto3_optional": true } }, "expectedStartTime": { "type": "google.protobuf.Timestamp", "id": 5, "options": { "(google.api.field_behavior)": "OPTIONAL", "proto3_optional": true } }, "duration": { "type": "google.protobuf.Duration", "id": 6, "options": { "(google.api.field_behavior)": "REQUIRED", "proto3_optional": true } }, "breakState": { "type": "AdBreakStateEnum.AdBreakState", "id": 7, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY", "proto3_optional": true } }, "breakSequence": { "type": "int64", "id": 8, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY", "proto3_optional": true } }, "podTemplateName": { "type": "string", "id": 9, "options": { "(google.api.field_behavior)": "OPTIONAL", "proto3_optional": true } }, "customParams": { "type": "string", "id": 10, "options": { "(google.api.field_behavior)": "OPTIONAL", "proto3_optional": true } }, "scte_35CueOut": { "type": "string", "id": 11, "options": { "(google.api.field_behavior)": "OPTIONAL", "proto3_optional": true } } } }, "AdBreakStateEnum": { "fields": {}, "nested": { "AdBreakState": { "values": { "AD_BREAK_STATE_UNSPECIFIED": 0, "DECISIONED": 1, "COMPLETE": 2, "SCHEDULED": 3 } } } }, "AdBreakService": { "options": { "(google.api.default_host)": "admanager.googleapis.com", "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/admanager" }, "methods": { "GetAdBreak": { "requestType": "GetAdBreakRequest", "responseType": "AdBreak", "options": { "(google.api.http).get": "/v1/{name=networks/*/liveStreamEventsByAssetKey/*/adBreaks/*}", "(google.api.http).additional_bindings.get": "/v1/{name=networks/*/liveStreamEvents/*/adBreaks/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{name=networks/*/liveStreamEventsByAssetKey/*/adBreaks/*}", "additional_bindings": [ { "get": "/v1/{name=networks/*/liveStreamEventsByCustomAssetKey/*/adBreaks/*}" }, { "get": "/v1/{name=networks/*/liveStreamEvents/*/adBreaks/*}" } ] } }, { "(google.api.method_signature)": "name" } ] }, "ListAdBreaks": { "requestType": "ListAdBreaksRequest", "responseType": "ListAdBreaksResponse", "options": { "(google.api.http).get": "/v1/{parent=networks/*/liveStreamEventsByAssetKey/*}/adBreaks", "(google.api.http).additional_bindings.get": "/v1/{parent=networks/*/liveStreamEvents/*}/adBreaks", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{parent=networks/*/liveStreamEventsByAssetKey/*}/adBreaks", "additional_bindings": [ { "get": "/v1/{parent=networks/*/liveStreamEventsByCustomAssetKey/*}/adBreaks" }, { "get": "/v1/{parent=networks/*/liveStreamEvents/*}/adBreaks" } ] } }, { "(google.api.method_signature)": "parent" } ] }, "CreateAdBreak": { "requestType": "CreateAdBreakRequest", "responseType": "AdBreak", "options": { "(google.api.http).post": "/v1/{parent=networks/*/liveStreamEventsByAssetKey/*}/adBreaks", "(google.api.http).body": "ad_break", "(google.api.http).additional_bindings.post": "/v1/{parent=networks/*/liveStreamEvents/*}/adBreaks", "(google.api.http).additional_bindings.body": "ad_break", "(google.api.method_signature)": "parent,ad_break" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{parent=networks/*/liveStreamEventsByAssetKey/*}/adBreaks", "body": "ad_break", "additional_bindings": [ { "post": "/v1/{parent=networks/*/liveStreamEventsByCustomAssetKey/*}/adBreaks", "body": "ad_break" }, { "post": "/v1/{parent=networks/*/liveStreamEvents/*}/adBreaks", "body": "ad_break" } ] } }, { "(google.api.method_signature)": "parent,ad_break" } ] }, "UpdateAdBreak": { "requestType": "UpdateAdBreakRequest", "responseType": "AdBreak", "options": { "(google.api.http).patch": "/v1/{ad_break.name=networks/*/liveStreamEventsByAssetKey/*/adBreaks/*}", "(google.api.http).body": "ad_break", "(google.api.method_signature)": "ad_break,update_mask" }, "parsedOptions": [ { "(google.api.http)": { "patch": "/v1/{ad_break.name=networks/*/liveStreamEventsByAssetKey/*/adBreaks/*}", "body": "ad_break" } }, { "(google.api.method_signature)": "ad_break,update_mask" } ] }, "DeleteAdBreak": { "requestType": "DeleteAdBreakRequest", "responseType": "google.protobuf.Empty", "options": { "(google.api.http).delete": "/v1/{name=networks/*/liveStreamEventsByAssetKey/*/adBreaks/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "delete": "/v1/{name=networks/*/liveStreamEventsByAssetKey/*/adBreaks/*}" } }, { "(google.api.method_signature)": "name" } ] } } }, "GetAdBreakRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "admanager.googleapis.com/AdBreak" } } } }, "ListAdBreaksRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "admanager.googleapis.com/LiveStreamEvent" } }, "pageSize": { "type": "int32", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "pageToken": { "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "filter": { "type": "string", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "orderBy": { "type": "string", "id": 5, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "skip": { "type": "int32", "id": 6, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "ListAdBreaksResponse": { "fields": { "adBreaks": { "rule": "repeated", "type": "AdBreak", "id": 1 }, "nextPageToken": { "type": "string", "id": 2 }, "totalSize": { "type": "int32", "id": 3 } } }, "CreateAdBreakRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "admanager.googleapis.com/LiveStreamEvent" } }, "adBreak": { "type": "AdBreak", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "UpdateAdBreakRequest": { "fields": { "adBreak": { "type": "AdBreak", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "updateMask": { "type": "google.protobuf.FieldMask", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "DeleteAdBreakRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "admanager.googleapis.com/AdBreak" } } } }, "AdUnitStatusEnum": { "fields": {}, "nested": { "AdUnitStatus": { "values": { "AD_UNIT_STATUS_UNSPECIFIED": 0, "ACTIVE": 1, "INACTIVE": 2, "ARCHIVED": 3 } } } }, "SmartSizeModeEnum": { "fields": {}, "nested": { "SmartSizeMode": { "values": { "SMART_SIZE_MODE_UNSPECIFIED": 0, "NONE": 1, "SMART_BANNER": 2, "DYNAMIC_SIZE": 3 } } } }, "TargetWindowEnum": { "fields": {}, "nested": { "TargetWindow": { "values": { "TARGET_WINDOW_UNSPECIFIED": 0, "TOP": 1, "BLANK": 2 } } } }, "AdUnit": { "options": { "(google.api.resource).type": "admanager.googleapis.com/AdUnit", "(google.api.resource).pattern": "networks/{network_code}/adUnits/{ad_unit}", "(google.api.resource).plural": "adUnits", "(google.api.resource).singular": "adUnit" }, "oneofs": { "_parentAdUnit": { "oneof": [ "parentAdUnit" ] }, "_displayName": { "oneof": [ "displayName" ] }, "_adUnitCode": { "oneof": [ "adUnitCode" ] }, "_status": { "oneof": [ "status" ] }, "_appliedTargetWindow": { "oneof": [ "appliedTargetWindow" ] }, "_effectiveTargetWindow": { "oneof": [ "effectiveTargetWindow" ] }, "_description": { "oneof": [ "description" ] }, "_explicitlyTargeted": { "oneof": [ "explicitlyTargeted" ] }, "_hasChildren": { "oneof": [ "hasChildren" ] }, "_updateTime": { "oneof": [ "updateTime" ] }, "_externalSetTopBoxChannelId": { "oneof": [ "externalSetTopBoxChannelId" ] }, "_refreshDelay": { "oneof": [ "refreshDelay" ] }, "_smartSizeMode": { "oneof": [ "smartSizeMode" ] }, "_appliedAdsenseEnabled": { "oneof": [ "appliedAdsenseEnabled" ] }, "_effectiveAdsenseEnabled": { "oneof": [ "effectiveAdsenseEnabled" ] } }, "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "IDENTIFIER" } }, "adUnitId": { "type": "int64", "id": 15, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "parentAdUnit": { "type": "string", "id": 10, "options": { "(google.api.field_behavior)": "IMMUTABLE", "(google.api.resource_reference).type": "admanager.googleapis.com/AdUnit", "proto3_optional": true } }, "parentPath": { "rule": "repeated", "type": "AdUnitParent", "id": 11, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "displayName": { "type": "string", "id": 9, "options": { "(google.api.field_behavior)": "REQUIRED", "proto3_optional": true } }, "adUnitCode": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "IMMUTABLE", "proto3_optional": true } }, "status": { "type": "AdUnitStatusEnum.AdUnitStatus", "id": 13, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY", "proto3_optional": true } }, "appliedTargetWindow": { "type": "TargetWindowEnum.TargetWindow", "id": 44, "options": { "(google.api.field_behavior)": "OPTIONAL", "proto3_optional": true } }, "effectiveTargetWindow": { "type": "TargetWindowEnum.TargetWindow", "id": 45, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY", "proto3_optional": true } }, "appliedTeams": { "rule": "repeated", "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "OPTIONAL", "(google.api.resource_reference).type": "admanager.googleapis.com/Team" } }, "teams": { "rule": "repeated", "type": "string", "id": 4, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY", "(google.api.resource_reference).type": "admanager.googleapis.com/Team" } }, "description": { "type": "string", "id": 5, "options": { "(google.api.field_behavior)": "OPTIONAL", "proto3_optional": true } }, "explicitlyTargeted": { "type": "bool", "id": 6, "options": { "(google.api.field_behavior)": "OPTIONAL", "proto3_optional": true } }, "hasChildren": { "type": "bool", "id": 7, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY", "proto3_optional": true } }, "updateTime": { "type": "google.protobuf.Timestamp", "id": 8, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY", "proto3_optional": true } }, "adUnitSizes": { "rule": "repeated", "type": "AdUnitSize", "id": 14, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "externalSetTopBoxChannelId": { "type": "string", "id": 17, "options": { "deprecated": true, "(google.api.field_behavior)": "OPTIONAL", "proto3_optional": true } }, "refreshDelay": { "type": "google.protobuf.Duration", "id": 19, "options": { "(google.api.field_behavior)": "OPTIONAL", "proto3_optional": true } }, "appliedLabels": { "rule": "repeated", "type": "AppliedLabel", "id": 21, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "effectiveAppliedLabels": { "rule": "repeated", "type": "AppliedLabel", "id": 22, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "appliedLabelFrequencyCaps": { "rule": "repeated", "type": "LabelFrequencyCap", "id": 23, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "effectiveLabelFrequencyCaps": { "rule": "repeated", "type": "LabelFrequencyCap", "id": 24, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "smartSizeMode": { "type": "SmartSizeModeEnum.SmartSizeMode", "id": 25, "options": { "(google.api.field_behavior)": "NON_EMPTY_DEFAULT", "proto3_optional": true } }, "appliedAdsenseEnabled": { "type": "bool", "id": 26, "options": { "(google.api.field_behavior)": "OPTIONAL", "proto3_optional": true } }, "effectiveAdsenseEnabled": { "type": "bool", "id": 27, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY", "proto3_optional": true } } } }, "AdUnitSize": { "fields": { "size": { "type": "Size", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "environmentType": { "type": "EnvironmentTypeEnum.EnvironmentType", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "companions": { "rule": "repeated", "type": "Size", "id": 3 } } }, "AdUnitParent": { "fields": { "parentAdUnit": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY", "(google.api.resource_reference).type": "admanager.googleapis.com/AdUnit" } }, "displayName": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "adUnitCode": { "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } } } }, "LabelFrequencyCap": { "fields": { "label": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "admanager.googleapis.com/Label" } }, "frequencyCap": { "type": "FrequencyCap", "id": 2 } } }, "AppliedLabel": { "fields": { "label": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "admanager.googleapis.com/Label" } }, "negated": { "type": "bool", "id": 2 } } }, "EnvironmentTypeEnum": { "fields": {}, "nested": { "EnvironmentType": { "values": { "ENVIRONMENT_TYPE_UNSPECIFIED": 0, "BROWSER": 1, "VIDEO_PLAYER": 2 } } } }, "FrequencyCap": { "oneofs": { "_maxImpressions": { "oneof": [ "maxImpressions" ] }, "_timeAmount": { "oneof": [ "timeAmount" ] }, "_timeUnit": { "oneof": [ "timeUnit" ] } }, "fields": { "maxImpressions": { "type": "int64", "id": 1, "options": { "proto3_optional": true } }, "timeAmount": { "type": "int64", "id": 2, "options": { "proto3_optional": true } }, "timeUnit": { "type": "TimeUnitEnum.TimeUnit", "id": 3, "options": { "proto3_optional": true } } } }, "TimeUnitEnum": { "fields": {}, "nested": { "TimeUnit": { "values": { "TIME_UNIT_UNSPECIFIED": 0, "MINUTE": 1, "HOUR": 2, "DAY": 3, "WEEK": 4, "MONTH": 5, "LIFETIME": 6, "POD": 7, "STREAM": 8 } } } }, "Size": { "fields": { "width": { "type": "int32", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "height": { "type": "int32", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "sizeType": { "type": "SizeTypeEnum.SizeType", "id": 3, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "SizeTypeEnum": { "fields": {}, "nested": { "SizeType": { "values": { "SIZE_TYPE_UNSPECIFIED": 0, "PIXEL": 1, "ASPECT_RATIO": 2, "INTERSTITIAL": 3, "IGNORED": 4, "NATIVE": 5, "FLUID": 6, "AUDIO": 7 } } } }, "AdUnitService": { "options": { "(google.api.default_host)": "admanager.googleapis.com", "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/admanager" }, "methods": { "GetAdUnit": { "requestType": "GetAdUnitRequest", "responseType": "AdUnit", "options": { "(google.api.http).get": "/v1/{name=networks/*/adUnits/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{name=networks/*/adUnits/*}" } }, { "(google.api.method_signature)": "name" } ] }, "ListAdUnits": { "requestType": "ListAdUnitsRequest", "responseType": "ListAdUnitsResponse", "options": { "(google.api.http).get": "/v1/{parent=networks/*}/adUnits", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{parent=networks/*}/adUnits" } }, { "(google.api.method_signature)": "parent" } ] }, "ListAdUnitSizes": { "requestType": "ListAdUnitSizesRequest", "responseType": "ListAdUnitSizesResponse", "options": { "(google.api.http).get": "/v1/{parent=networks/*}/adUnitSizes", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{parent=networks/*}/adUnitSizes" } }, { "(google.api.method_signature)": "parent" } ] } } }, "GetAdUnitRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "admanager.googleapis.com/AdUnit" } } } }, "ListAdUnitsRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "admanager.googleapis.com/Network" } }, "pageSize": { "type": "int32", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "pageToken": { "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "filter": { "type": "string", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "orderBy": { "type": "string", "id": 5, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "skip": { "type": "int32", "id": 6, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "ListAdUnitsResponse": { "fields": { "adUnits": { "rule": "repeated", "type": "AdUnit", "id": 1 }, "nextPageToken": { "type": "string", "id": 2 }, "totalSize": { "type": "int32", "id": 3 } } }, "ListAdUnitSizesRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "admanager.googleapis.com/Network" } }, "pageSize": { "type": "int32", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "pageToken": { "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "filter": { "type": "string", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "orderBy": { "type": "string", "id": 5, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "skip": { "type": "int32", "id": 6, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "ListAdUnitSizesResponse": { "fields": { "adUnitSizes": { "rule": "repeated", "type": "AdUnitSize", "id": 1 }, "nextPageToken": { "type": "string", "id": 2 }, "totalSize": { "type": "int32", "id": 3 } } }, "AdManagerError": { "fields": { "errorCode": { "type": "string", "id": 1 }, "message": { "type": "string", "id": 2 }, "fieldPath": { "type": "string", "id": 3 }, "trigger": { "type": "string", "id": 4 }, "stackTrace": { "type": "string", "id": 5 }, "details": { "rule": "repeated", "type": "google.protobuf.Any", "id": 6