Publisher Settings Protocol Buffer
Stay organized with collections
Save and categorize content based on your preferences.
View raw content
Back to Reference page
// Protocol version: v.13
// Copyright 2024 Google Inc. All Rights Reserved.
// Protocol buffers for communicating publisher restrictions to networks.
// A set of publisher settings specific to a RTB Network.
message PublisherSettingsList {
repeated PublisherSettings publisher_settings = 1;
}
// A collection of settings that applies to a publisher's web property or
// channel.
message PublisherSettings {
// Identifies the web property and channel to which these settings apply.
// This field corresponds to publisher_settings_list_id in the BidRequest
// or BidRequest.AdSlot.
optional fixed64 id = 10;
// These landing page URLs are blocked by the seller for all ad slots marked
// with this id. They should be matched by substring.
repeated string excluded_url = 2;
// Disallowed sensitive ad categories. This field corresponds to
// excluded_sensitive_category in the BidRequest. See the
// ad-sensitive-categories.txt file in the technical documentation for a list
// of sensitive ad categories.
repeated int32 excluded_sensitive_category = 9;
// Disallowed product categories. This field corresponds to
// excluded_product_category in the BidRequest.
repeated int32 excluded_product_category = 8;
// Disallowed attribute ids for the ads that can show in this
// slot. See the creative-attributes.txt file in the technical
// documentation for a list of ids.
repeated int32 excluded_attribute = 4;
// Allowed vendor types. See the vendors.txt file in the technical
// documentation for a list of ids.
repeated int32 allowed_vendor_type = 5;
// No longer used as of June 2016.
optional bool DEPRECATED_can_send_ip = 7 [default = true, deprecated = true];
// The languages that are allowed to be shown on the publisher's site.
// Each language is a Language Code, such as 'en' or 'pt-BR', as defined by
// Unicode's "CLDR" (http://unicode.org/cldr/)
repeated string allowed_language = 11;
}
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-18 UTC.
[null,null,["Last updated 2025-08-18 UTC."],[[["\u003cp\u003eThis document outlines protocol buffers for communicating publisher restrictions, like blocked URLs and disallowed ad categories, to ad networks in real-time bidding (RTB).\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ePublisherSettings\u003c/code\u003e define restrictions for a specific publisher's web property or channel, impacting which ads can be shown.\u003c/p\u003e\n"],["\u003cp\u003eThese settings control aspects such as excluded URLs, sensitive and product categories, ad attributes, allowed vendor types, and languages.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ePublisherSettingsList\u003c/code\u003e acts as a container for multiple \u003ccode\u003ePublisherSettings\u003c/code\u003e, allowing for the management of various restrictions across different properties.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use the provided IDs and category lists found in external files like \u003ccode\u003ead-sensitive-categories.txt\u003c/code\u003e and \u003ccode\u003evendors.txt\u003c/code\u003e to utilize and interpret the settings accurately.\u003c/p\u003e\n"]]],[],null,["# Publisher Settings Protocol Buffer\n\n[View raw content](/static/authorized-buyers/rtb/downloads/publisher-settings-proto.txt)\n[Back to Reference page](/authorized-buyers/rtb/data#protos) \n\n```carbon\n// Protocol version: v.13\n// Copyright 2024 Google Inc. All Rights Reserved.\n\n// Protocol buffers for communicating publisher restrictions to networks.\n\n// A set of publisher settings specific to a RTB Network.\nmessage PublisherSettingsList {\n repeated PublisherSettings publisher_settings = 1;\n}\n\n// A collection of settings that applies to a publisher's web property or\n// channel.\nmessage PublisherSettings {\n // Identifies the web property and channel to which these settings apply.\n // This field corresponds to publisher_settings_list_id in the BidRequest\n // or BidRequest.AdSlot.\n optional fixed64 id = 10;\n\n // These landing page URLs are blocked by the seller for all ad slots marked\n // with this id. They should be matched by substring.\n repeated string excluded_url = 2;\n\n // Disallowed sensitive ad categories. This field corresponds to\n // excluded_sensitive_category in the BidRequest. See the\n // ad-sensitive-categories.txt file in the technical documentation for a list\n // of sensitive ad categories.\n repeated int32 excluded_sensitive_category = 9;\n\n // Disallowed product categories. This field corresponds to\n // excluded_product_category in the BidRequest.\n repeated int32 excluded_product_category = 8;\n\n // Disallowed attribute ids for the ads that can show in this\n // slot. See the creative-attributes.txt file in the technical\n // documentation for a list of ids.\n repeated int32 excluded_attribute = 4;\n\n // Allowed vendor types. See the vendors.txt file in the technical\n // documentation for a list of ids.\n repeated int32 allowed_vendor_type = 5;\n\n // No longer used as of June 2016.\n optional bool DEPRECATED_can_send_ip = 7 [default = true, deprecated = true];\n\n // The languages that are allowed to be shown on the publisher's site.\n // Each language is a Language Code, such as 'en' or 'pt-BR', as defined by\n // Unicode's \"CLDR\" (http://unicode.org/cldr/)\n repeated string allowed_language = 11;\n}\n```"]]