@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": { "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": { "_appliedAdsenseEnabled": { "oneof": [ "appliedAdsenseEnabled" ] } }, "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" } }, "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" } }, "adUnitCode": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "IMMUTABLE" } }, "status": { "type": "AdUnitStatusEnum.AdUnitStatus", "id": 13, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "appliedTargetWindow": { "type": "TargetWindowEnum.TargetWindow", "id": 44, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "effectiveTargetWindow": { "type": "TargetWindowEnum.TargetWindow", "id": 45, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "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" } }, "explicitlyTargeted": { "type": "bool", "id": 6, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "hasChildren": { "type": "bool", "id": 7, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "updateTime": { "type": "google.protobuf.Timestamp", "id": 8, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "adUnitSizes": { "rule": "repeated", "type": "AdUnitSize", "id": 14, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "externalSetTopBoxChannelId": { "type": "string", "id": 17, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "refreshDelay": { "type": "google.protobuf.Duration", "id": 19, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "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)": "OPTIONAL" } }, "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" } } } }, "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" }, "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 } } }, "CompanyCreditStatusEnum": { "fields": {}, "nested": { "CompanyCreditStatus": { "values": { "COMPANY_CREDIT_STATUS_UNSPECIFIED": 0, "ACTIVE": 1, "INACTIVE": 2, "ON_HOLD": 3, "STOP": 4, "BLOCKED": 5 } } } }, "Company": { "options": { "(google.api.resource).type": "admanager.googleapis.com/Company", "(google.api.resource).pattern": "networks/{network_code}/companies/{company}", "(google.api.resource).plural": "companies", "(google.api.resource).singular": "company" }, "oneofs": { "_primaryContact": { "oneof": [ "primaryContact" ] } }, "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "IDENTIFIER" } }, "companyId": { "type": "int64", "id": 2, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "displayName": { "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "type": { "type": "CompanyTypeEnum.CompanyType", "id": 4, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "address": { "type": "string", "id": 5, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "email": { "type": "string", "id": 6, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "fax": { "type": "string", "id": 7, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "phone": { "type": "string", "id": 8, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "externalId": { "type": "string", "id": 9, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "comment": { "type": "string", "id": 10, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "creditStatus": { "type": "CompanyCreditStatusEnum.CompanyCreditStatus", "id": 11, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "appliedLabels": { "rule": "repeated", "type": "AppliedLabel", "id": 12, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "primaryContact": { "type": "string", "id": 13, "options": { "(google.api.field_behavior)": "OPTIONAL", "(google.api.resource_reference).type": "admanager.googleapis.com/Contact", "proto3_optional": true } }, "appliedTeams": { "rule": "repeated", "type": "string", "id": 14, "options": { "(google.api.field_behavior)": "OPTIONAL", "(google.api.resource_reference).type": "admanager.googleapis.com/Team" } }, "updateTime": { "type": "google.protobuf.Timestamp", "id": 15, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "thirdPartyCompanyId": { "type": "int64", "id": 16, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "CompanyTypeEnum": { "fields": {}, "nested": { "CompanyType": { "values": { "COMPANY_TYPE_UNSPECIFIED": 0, "ADVERTISER": 1, "HOUSE_ADVERTISER": 2, "AGENCY": 3, "HOUSE_AGENCY": 4, "AD_NETWORK": 5 } } } }, "CompanyService": { "options": { "(google.api.default_host)": "admanager.googleapis.com" }, "methods": { "GetCompany": { "requestType": "GetCompanyRequest", "responseType": "Company", "options": { "(google.api.http).get": "/v1/{name=networks/*/companies/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{name=networks/*/companies/*}" } }, { "(google.api.method_signature)": "name" } ] }, "ListCompanies": { "requestType": "ListCompaniesRequest", "responseType": "ListCompaniesResponse", "options": { "(google.api.http).get": "/v1/{parent=networks/*}/companies", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{parent=networks/*}/companies" } }, { "(google.api.method_signature)": "parent" } ] } } }, "GetCompanyRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "admanager.googleapis.com/Company" } } } }, "ListCompaniesRequest": { "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" } } } }, "ListCompaniesResponse": { "fields": { "companies": { "rule": "repeated", "type": "Company", "id": 1 }, "nextPageToken": { "type": "string", "id": 2 }, "totalSize": { "type": "int32", "id": 3 } } }, "Contact": { "options": { "(google.api.resource).type": "admanager.googleapis.com/Contact", "(google.api.resource).pattern": "networks/{network_code}/contacts/{contact}", "(google.api.resource).plural": "contacts", "(google.api.resource).singular": "contact" }, "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "IDENTIFIER" } }, "contactId": { "type": "int64", "id": 2, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } } } }, "CustomFieldDataTypeEnum": { "fields": {}, "nested": { "CustomFieldDataType": { "values": { "CUSTOM_FIELD_DATA_TYPE_UNSPECIFIED": 0, "STRING": 1, "NUMBER": 2, "TOGGLE": 3, "DROP_DOWN": 4 } } } }, "CustomFieldEntityTypeEnum": { "fields": {}, "nested": { "CustomFieldEntityType": { "values": { "CUSTOM_FIELD_ENTITY_TYPE_UNSPECIFIED": 0, "LINE_ITEM": 1, "ORDER": 2, "CREATIVE": 3, "PROPOSAL": 4, "PROPOSAL_LINE_ITEM": 5 } } } }, "CustomFieldStatusEnum": { "fields": {}, "nested": { "CustomFieldStatus": { "values": { "CUSTOM_FIELD_STATUS_UNSPECIFIED": 0, "ACTIVE": 1, "INACTIVE": 2 } } } }, "CustomFieldVisibilityEnum": { "fields": {}, "nested": { "CustomFieldVisibility": { "values": { "CUSTOM_FIELD_VISIBILITY_UNSPECIFIED": 0, "HIDDEN": 1, "READ_ONLY": 2, "EDITABLE": 3 } } } }, "CustomField": { "options": { "(google.api.resource).type": "admanager.googleapis.com/CustomField", "(google.api.resource).pattern": "networks/{network_code}/customFields/{custom_field}", "(google.api.resource).plural": "customFields", "(google.api.resource).singular": "customField" }, "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "IDENTIFIER" } }, "customFieldId": { "type": "int64", "id": 2, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "displayName": { "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "description": { "type": "string", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "status": { "type": "CustomFieldStatusEnum.CustomFieldStatus", "id": 5, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "entityType": { "type": "CustomFieldEntityTypeEnum.CustomFieldEntityType", "id": 7, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "dataType": { "type": "CustomFieldDataTypeEnum.CustomFieldDataType", "id": 8, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "visibility": { "type": "CustomFieldVisibilityEnum.CustomFieldVisibility", "id": 9, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "options": { "rule": "repeated", "type": "CustomFieldOption", "id": 10, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "CustomFieldOption": { "fields": { "customFieldOptionId": { "type": "int64", "id": 1, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "displayName": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "CustomFieldService": { "options": { "(google.api.default_host)": "admanager.googleapis.com" }, "methods": { "GetCustomField": { "requestType": "GetCustomFieldRequest", "responseType": "CustomField", "options": { "(google.api.http).get": "/v1/{name=networks/*/customFields/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{name=networks/*/customFields/*}" } }, { "(google.api.method_signature)": "name" } ] }, "ListCustomFields": { "requestType": "ListCustomFieldsRequest", "responseType": "ListCustomFieldsResponse", "options": { "(google.api.http).get": "/v1/{parent=networks/*}/customFields", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{parent=networks/*}/customFields" } }, { "(google.api.method_signature)": "parent" } ] } } }, "GetCustomFieldRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "admanager.googleapis.com/CustomField" } } } }, "ListCustomFieldsRequest": { "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": { "(