com.google.ads.googleads.v17.resources.FeedItemOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/resources/feed_item.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.resources;

public interface FeedItemOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.FeedItem)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Immutable. The resource name of the feed item.
   * Feed item resource names have the form:
   *
   * `customers/{customer_id}/feedItems/{feed_id}~{feed_item_id}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The resourceName.
   */
  java.lang.String getResourceName();
  /**
   *    * Immutable. The resource name of the feed item.
   * Feed item resource names have the form:
   *
   * `customers/{customer_id}/feedItems/{feed_id}~{feed_item_id}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

  /**
   *    * Immutable. The feed to which this feed item belongs.
   * 
   *
   * optional string feed = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return Whether the feed field is set.
   */
  boolean hasFeed();
  /**
   *    * Immutable. The feed to which this feed item belongs.
   * 
   *
   * optional string feed = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The feed.
   */
  java.lang.String getFeed();
  /**
   *    * Immutable. The feed to which this feed item belongs.
   * 
   *
   * optional string feed = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for feed.
   */
  com.google.protobuf.ByteString
      getFeedBytes();

  /**
   *    * Output only. The ID of this feed item.
   * 
   *
   * optional int64 id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the id field is set.
   */
  boolean hasId();
  /**
   *    * Output only. The ID of this feed item.
   * 
   *
   * optional int64 id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The id.
   */
  long getId();

  /**
   *    * Start time in which this feed item is effective and can begin serving. The
   * time is in the customer's time zone.
   * The format is "YYYY-MM-DD HH:MM:SS".
   * Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
   * 
   *
   * optional string start_date_time = 13;
   * @return Whether the startDateTime field is set.
   */
  boolean hasStartDateTime();
  /**
   *    * Start time in which this feed item is effective and can begin serving. The
   * time is in the customer's time zone.
   * The format is "YYYY-MM-DD HH:MM:SS".
   * Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
   * 
   *
   * optional string start_date_time = 13;
   * @return The startDateTime.
   */
  java.lang.String getStartDateTime();
  /**
   *    * Start time in which this feed item is effective and can begin serving. The
   * time is in the customer's time zone.
   * The format is "YYYY-MM-DD HH:MM:SS".
   * Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
   * 
   *
   * optional string start_date_time = 13;
   * @return The bytes for startDateTime.
   */
  com.google.protobuf.ByteString
      getStartDateTimeBytes();

  /**
   *    * End time in which this feed item is no longer effective and will stop
   * serving. The time is in the customer's time zone.
   * The format is "YYYY-MM-DD HH:MM:SS".
   * Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
   * 
   *
   * optional string end_date_time = 14;
   * @return Whether the endDateTime field is set.
   */
  boolean hasEndDateTime();
  /**
   *    * End time in which this feed item is no longer effective and will stop
   * serving. The time is in the customer's time zone.
   * The format is "YYYY-MM-DD HH:MM:SS".
   * Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
   * 
   *
   * optional string end_date_time = 14;
   * @return The endDateTime.
   */
  java.lang.String getEndDateTime();
  /**
   *    * End time in which this feed item is no longer effective and will stop
   * serving. The time is in the customer's time zone.
   * The format is "YYYY-MM-DD HH:MM:SS".
   * Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
   * 
   *
   * optional string end_date_time = 14;
   * @return The bytes for endDateTime.
   */
  com.google.protobuf.ByteString
      getEndDateTimeBytes();

  /**
   *    * The feed item's attribute values.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.FeedItemAttributeValue attribute_values = 6;
   */
  java.util.List 
      getAttributeValuesList();
  /**
   *    * The feed item's attribute values.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.FeedItemAttributeValue attribute_values = 6;
   */
  com.google.ads.googleads.v17.resources.FeedItemAttributeValue getAttributeValues(int index);
  /**
   *    * The feed item's attribute values.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.FeedItemAttributeValue attribute_values = 6;
   */
  int getAttributeValuesCount();
  /**
   *    * The feed item's attribute values.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.FeedItemAttributeValue attribute_values = 6;
   */
  java.util.List 
      getAttributeValuesOrBuilderList();
  /**
   *    * The feed item's attribute values.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.FeedItemAttributeValue attribute_values = 6;
   */
  com.google.ads.googleads.v17.resources.FeedItemAttributeValueOrBuilder getAttributeValuesOrBuilder(
      int index);

  /**
   *    * Geo targeting restriction specifies the type of location that can be used
   * for targeting.
   * 
   *
   * .google.ads.googleads.v17.enums.GeoTargetingRestrictionEnum.GeoTargetingRestriction geo_targeting_restriction = 7;
   * @return The enum numeric value on the wire for geoTargetingRestriction.
   */
  int getGeoTargetingRestrictionValue();
  /**
   *    * Geo targeting restriction specifies the type of location that can be used
   * for targeting.
   * 
   *
   * .google.ads.googleads.v17.enums.GeoTargetingRestrictionEnum.GeoTargetingRestriction geo_targeting_restriction = 7;
   * @return The geoTargetingRestriction.
   */
  com.google.ads.googleads.v17.enums.GeoTargetingRestrictionEnum.GeoTargetingRestriction getGeoTargetingRestriction();

  /**
   *    * The list of mappings used to substitute custom parameter tags in a
   * `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
   * 
   *
   * repeated .google.ads.googleads.v17.common.CustomParameter url_custom_parameters = 8;
   */
  java.util.List 
      getUrlCustomParametersList();
  /**
   *    * The list of mappings used to substitute custom parameter tags in a
   * `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
   * 
   *
   * repeated .google.ads.googleads.v17.common.CustomParameter url_custom_parameters = 8;
   */
  com.google.ads.googleads.v17.common.CustomParameter getUrlCustomParameters(int index);
  /**
   *    * The list of mappings used to substitute custom parameter tags in a
   * `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
   * 
   *
   * repeated .google.ads.googleads.v17.common.CustomParameter url_custom_parameters = 8;
   */
  int getUrlCustomParametersCount();
  /**
   *    * The list of mappings used to substitute custom parameter tags in a
   * `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
   * 
   *
   * repeated .google.ads.googleads.v17.common.CustomParameter url_custom_parameters = 8;
   */
  java.util.List 
      getUrlCustomParametersOrBuilderList();
  /**
   *    * The list of mappings used to substitute custom parameter tags in a
   * `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
   * 
   *
   * repeated .google.ads.googleads.v17.common.CustomParameter url_custom_parameters = 8;
   */
  com.google.ads.googleads.v17.common.CustomParameterOrBuilder getUrlCustomParametersOrBuilder(
      int index);

  /**
   *    * Output only. Status of the feed item.
   * This field is read-only.
   * 
   *
   * .google.ads.googleads.v17.enums.FeedItemStatusEnum.FeedItemStatus status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * Output only. Status of the feed item.
   * This field is read-only.
   * 
   *
   * .google.ads.googleads.v17.enums.FeedItemStatusEnum.FeedItemStatus status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.FeedItemStatusEnum.FeedItemStatus getStatus();

  /**
   *    * Output only. List of info about a feed item's validation and approval state
   * for active feed mappings. There will be an entry in the list for each type
   * of feed mapping associated with the feed, for example, a feed with a
   * sitelink and a call feed mapping would cause every feed item associated
   * with that feed to have an entry in this list for both sitelink and call.
   * This field is read-only.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.FeedItemPlaceholderPolicyInfo policy_infos = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  java.util.List 
      getPolicyInfosList();
  /**
   *    * Output only. List of info about a feed item's validation and approval state
   * for active feed mappings. There will be an entry in the list for each type
   * of feed mapping associated with the feed, for example, a feed with a
   * sitelink and a call feed mapping would cause every feed item associated
   * with that feed to have an entry in this list for both sitelink and call.
   * This field is read-only.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.FeedItemPlaceholderPolicyInfo policy_infos = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.resources.FeedItemPlaceholderPolicyInfo getPolicyInfos(int index);
  /**
   *    * Output only. List of info about a feed item's validation and approval state
   * for active feed mappings. There will be an entry in the list for each type
   * of feed mapping associated with the feed, for example, a feed with a
   * sitelink and a call feed mapping would cause every feed item associated
   * with that feed to have an entry in this list for both sitelink and call.
   * This field is read-only.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.FeedItemPlaceholderPolicyInfo policy_infos = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  int getPolicyInfosCount();
  /**
   *    * Output only. List of info about a feed item's validation and approval state
   * for active feed mappings. There will be an entry in the list for each type
   * of feed mapping associated with the feed, for example, a feed with a
   * sitelink and a call feed mapping would cause every feed item associated
   * with that feed to have an entry in this list for both sitelink and call.
   * This field is read-only.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.FeedItemPlaceholderPolicyInfo policy_infos = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  java.util.List 
      getPolicyInfosOrBuilderList();
  /**
   *    * Output only. List of info about a feed item's validation and approval state
   * for active feed mappings. There will be an entry in the list for each type
   * of feed mapping associated with the feed, for example, a feed with a
   * sitelink and a call feed mapping would cause every feed item associated
   * with that feed to have an entry in this list for both sitelink and call.
   * This field is read-only.
   * 
   *
   * repeated .google.ads.googleads.v17.resources.FeedItemPlaceholderPolicyInfo policy_infos = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.resources.FeedItemPlaceholderPolicyInfoOrBuilder getPolicyInfosOrBuilder(
      int index);
}