Feed

フィード。

JSON 表現
{
  "resourceName": string,
  "attributes": [
    {
      object (FeedAttribute)
    }
  ],
  "attributeOperations": [
    {
      object (FeedAttributeOperation)
    }
  ],
  "origin": enum (FeedOrigin),
  "status": enum (FeedStatus),
  "id": string,
  "name": string,

  // Union field system_feed_generation_data can be only one of the following:
  "placesLocationFeedData": {
    object (PlacesLocationFeedData)
  },
  "affiliateLocationFeedData": {
    object (AffiliateLocationFeedData)
  }
  // End of list of possible types for union field system_feed_generation_data.
}
フィールド
resourceName

string

変更不可。フィードのリソース名。フィードのリソース名の形式は次のとおりです。

customers/{customerId}/feeds/{feedId}

attributes[]

object (FeedAttribute)

フィードの属性。CREATE では必須です。system_feed_generation_data を指定した場合は、Google 広告によってフィードが正しい属性で更新されます。UPDATE では許可されません。新しい属性を追加するには、attributeOperations を使用します。

attributeOperations[]

object (FeedAttributeOperation)

フィード属性を変更するオペレーションのリスト。属性は追加のみ可能で、削除はできません。

origin

enum (FeedOrigin)

変更不可。フィードの FeedAttributes を管理するユーザーを指定します。

status

enum (FeedStatus)

出力のみ。フィードのステータス。このフィールドは読み取り専用です。

id

string (int64 format)

出力のみ。フィードの ID。このフィールドは読み取り専用です。

name

string

変更不可。フィードの名前。必須。

共用体フィールド system_feed_generation_data。フィードのシステムデータです。このデータでは、システムで生成されたフィードのフィード アイテムを生成するための情報を指定します。system_feed_generation_data は次のいずれかになります。
placesLocationFeedData

object (PlacesLocationFeedData)

ビジネス プロフィールから入力されたロケーション フィードの設定に使用されるデータ。

affiliateLocationFeedData

object (AffiliateLocationFeedData)

指定したチェーンが入力されたアフィリエイト住所フィードの設定に使用されるデータ。

FeedAttribute

FeedAttributes は、フィードに存在することが想定されるデータの種類を定義します。1 つの FeedAttribute で、同じ FeedAttributeId を持つ FeedItemAttributes の型を指定します。必要に応じて、FeedAttribute を FeedItem の一意のキーの一部としてマークできます。

JSON 表現
{
  "type": enum (FeedAttributeType),
  "id": string,
  "name": string,
  "isPartOfKey": boolean
}
フィールド
type

enum (FeedAttributeType)

フィード属性のデータタイプ。必須。

id

string (int64 format)

属性の ID。

name

string

属性の名前。必須。

isPartOfKey

boolean

この属性に対応するデータが FeedItem の一意のキーの一部であることを示します。指定しない場合はデフォルトで false になります。フィードのスキーマに一意のキーは必須ではありません。その場合、FeedItem は feed_item_id で参照する必要があります。

FeedAttributeType

フィード属性に使用できるデータ型。

列挙型
UNSPECIFIED 指定されていません。
UNKNOWN 戻り値にのみ使用されます。このバージョンで不明な値を表します。
INT64 Int64
DOUBLE 倍精度。
STRING 文字列。
BOOLEAN Boolean 型。
URL URL
DATE_TIME 日時。
INT64_LIST int64 リスト。
DOUBLE_LIST ダブル(8 バイト)リスト。
STRING_LIST 文字列リスト。
BOOLEAN_LIST ブール値リスト。
URL_LIST URL リスト。
DATE_TIME_LIST 日時リスト。
PRICE 価格。

FeedAttributeOperation

ミューテーションのフィード属性リストに対して実行されるオペレーション。

JSON 表現
{
  "operator": enum (Operator),
  "value": {
    object (FeedAttribute)
  }
}
フィールド
operator

enum (Operator)

出力のみ。実行するリスト操作のタイプ。

value

object (FeedAttribute)

出力のみ。リストに追加されるフィード属性。

演算子

演算子。

列挙型
UNSPECIFIED (指定なし)
UNKNOWN 戻り値にのみ使用されます。このバージョンで不明な値を表します。
ADD 属性を既存の属性に追加します。

FeedOrigin

フィード元として指定可能な値。

列挙型
UNSPECIFIED 指定されていません。
UNKNOWN 戻り値にのみ使用されます。このバージョンで不明な値を表します。
USER このフィードの FeedAttributes はユーザーが管理します。ユーザーはこのフィードに FeedAttributes を追加できます。
GOOGLE GOOGLE フィードの FeedAttributes は Google によって作成されます。このタイプのフィードは Google によって管理され、フィードのプレースホルダ タイプに応じた適切な属性が設定されます。

FeedStatus

フィードのステータス。

列挙型
UNSPECIFIED 指定されていません。
UNKNOWN 戻り値にのみ使用されます。このバージョンで不明な値を表します。
ENABLED フィードが有効です。
REMOVED フィードが削除されました。

PlacesLocationFeedData

ビジネス プロフィールから入力されたロケーション フィードの設定に使用されるデータ。

JSON 表現
{
  "oauthInfo": {
    object (OAuthInfo)
  },
  "businessAccountId": string,
  "categoryFilters": [
    string
  ],
  "labelFilters": [
    string
  ],
  "emailAddress": string,
  "businessNameFilter": string
}
フィールド
oauthInfo

object (OAuthInfo)

変更不可。メールに必要な認証トークン(OAuth API から)。このフィールドは作成リクエストでのみ指定できます。サブフィールドは選択できません。

businessAccountId

string

ビジネス情報を使用する管理対象ビジネスの Google+ ページ ID。このフィールドが設定されていない場合、ユーザーがアクセスできるすべてのビジネス(emailAddress で指定)が使用されます。このフィールドはミューテーションのみで、選択できません。

categoryFilters[]

string

ビジネス プロフィールのリスティングをカテゴリでフィルタするために使用します。categoryFilters 内にエントリが存在する場合は、いずれかのカテゴリに属するリスティングのみが FeedItems に同期される候補になります。categoryFilters にエントリが存在しない場合、すべてのリスティングが同期の対象となる候補です。

labelFilters[]

string

ビジネス プロフィールのリスティングをラベルでフィルタするために使用します。labelFilters にエントリが存在する場合は、いずれかのラベルが設定されているリスティングのみが FeedItem と同期する候補になります。labelFilters にエントリが存在しない場合は、すべてのリスティングが同期の候補になります。

emailAddress

string

ビジネス プロフィールのメールアドレス、またはビジネス プロフィールの管理者のメールアドレス。必須。

businessNameFilter

string

ビジネス プロフィールのリスティングをビジネス名でフィルタするために使用されます。businessNameFilter を設定すると、お店やサービスの名前が一致するリスティングのみが FeedItem に同期される候補になります。

OAuthInfo

OAuth による認証に使用されるデータ。

JSON 表現
{
  "httpMethod": string,
  "httpRequestUrl": string,
  "httpAuthorizationHeader": string
}
フィールド
httpMethod

string

承認を取得するために使用される HTTP メソッド。

httpRequestUrl

string

承認を取得するために使用される HTTP リクエスト URL。

httpAuthorizationHeader

string

承認を取得するために使用される HTTP 認証ヘッダー。

AffiliateLocationFeedData

指定したチェーンが入力されたアフィリエイト住所フィードの設定に使用されるデータ。

JSON 表現
{
  "chainIds": [
    string
  ],
  "relationshipType": enum (AffiliateLocationFeedRelationshipType)
}
フィールド
chainIds[]

string (int64 format)

アフィリエイト住所フィードでビジネス情報を同期するチェーンのリスト。

relationshipType

enum (AffiliateLocationFeedRelationshipType)

チェーンと広告主様との関係。

AffiliateLocationFeedRelationshipType

アフィリエイト住所フィードの関係タイプに使用できる値。

列挙型
UNSPECIFIED 指定されていません。
UNKNOWN 戻り値にのみ使用されます。このバージョンで不明な値を表します。
GENERAL_RETAILER 一般的な販売店との関係。