Campaign Manager 360 API v3.4 はサポートが終了し、2021 年 12 月 24 日に廃止されます。この日までに、すべてのユーザーが新しいバージョンの API に移行する必要があります。

Reports

Reports はレポート リソースのリストです。アプリケーションで Reports のメソッドを使用することで、レポートのリストを取得したり、新しいレポートを作成したり、既存のレポートを更新したりできます。また、レポートを実行して File リソースを作成することもできます。

このリソースのメソッドの一覧は、このページの最後をご覧ください。

リソース表現

Reports リソースは次のように表されます。

{
  "kind": "dfareporting#report",
  "id": long,
  "etag": etag,
  "lastModifiedTime": unsigned long,
  "ownerProfileId": long,
  "accountId": long,
  "subAccountId": long,
  "name": string,
  "fileName": string,
  "format": string,
  "type": string,
  "criteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "dimensionFilters": [
      dimensionValues Resource
    ],
    "activities": {
      "kind": "dfareporting#activities",
      "filters": [
        dimensionValues Resource
      ],
      "metricNames": [
        string
      ]
    },
    "customRichMediaEvents": {
      "kind": "dfareporting#customRichMediaEvents",
      "filteredEventIds": [
        dimensionValues Resource
      ]
    }
  },
  "pathToConversionCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "floodlightConfigId": dimensionValues Resource,
    "activityFilters": [
      dimensionValues Resource
    ],
    "conversionDimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "perInteractionDimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "customFloodlightVariables": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "customRichMediaEvents": [
      dimensionValues Resource
    ],
    "reportProperties": {
      "clicksLookbackWindow": integer,
      "impressionsLookbackWindow": integer,
      "maximumInteractionGap": integer,
      "maximumClickInteractions": integer,
      "maximumImpressionInteractions": integer,
      "includeAttributedIPConversions": boolean,
      "includeUnattributedIPConversions": boolean,
      "includeUnattributedCookieConversions": boolean,
      "pivotOnInteractionPath": boolean
    }
  },
  "reachCriteria": {
    "enableAllDimensionCombinations": boolean,
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "reachByFrequencyMetricNames": [
      string
    ],
    "dimensionFilters": [
      dimensionValues Resource
    ],
    "activities": {
      "kind": "dfareporting#activities",
      "filters": [
        dimensionValues Resource
      ],
      "metricNames": [
        string
      ]
    },
    "customRichMediaEvents": {
      "kind": "dfareporting#customRichMediaEvents",
      "filteredEventIds": [
        dimensionValues Resource
      ]
    }
  },
  "crossDimensionReachCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "dimension": string,
    "pivoted": boolean,
    "dimensionFilters": [
      dimensionValues Resource
    ],
    "breakdown": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "overlapMetricNames": [
      string
    ]
  },
  "floodlightCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "floodlightConfigId": dimensionValues Resource,
    "dimensionFilters": [
      dimensionValues Resource
    ],
    "reportProperties": {
      "includeAttributedIPConversions": boolean,
      "includeUnattributedIPConversions": boolean,
      "includeUnattributedCookieConversions": boolean
    },
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "customRichMediaEvents": [
      dimensionValues Resource
    ]
  },
  "pathCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "floodlightConfigId": dimensionValues Resource,
    "activityFilters": [
      dimensionValues Resource
    ],
    "customChannelGrouping": {
      "kind": "dfareporting#channelGrouping",
      "name": string,
      "fallbackName": string,
      "rules": [
        {
          "kind": "dfareporting#channelGroupingRule",
          "name": string,
          "disjunctiveMatchStatements": [
            {
              "kind": "dfareporting#disjunctiveMatchStatement",
              "eventFilters": [
                {
                  "kind": "dfareporting#eventFilter",
                  "dimensionFilter": {
                    "kind": "dfareporting#pathReportDimensionValue",
                    "dimensionName": string,
                    "values": [
                      string
                    ],
                    "ids": [
                      string
                    ],
                    "matchType": string
                  }
                }
              ]
            }
          ]
        }
      ]
    },
    "pathFilters": [
      {
        "kind": "dfaReporting#pathFilter",
        "eventFilters": [
          {
            "kind": "dfareporting#eventFilter",
            "dimensionFilter": {
              "kind": "dfareporting#pathReportDimensionValue",
              "dimensionName": string,
              "values": [
                string
              ],
              "ids": [
                string
              ],
              "matchType": string
            }
          }
        ],
        "pathMatchPosition": string
      }
    ],
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ]
  },
  "pathAttributionCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "floodlightConfigId": dimensionValues Resource,
    "activityFilters": [
      dimensionValues Resource
    ],
    "customChannelGrouping": {
      "kind": "dfareporting#channelGrouping",
      "name": string,
      "fallbackName": string,
      "rules": [
        {
          "kind": "dfareporting#channelGroupingRule",
          "name": string,
          "disjunctiveMatchStatements": [
            {
              "kind": "dfareporting#disjunctiveMatchStatement",
              "eventFilters": [
                {
                  "kind": "dfareporting#eventFilter",
                  "dimensionFilter": {
                    "kind": "dfareporting#pathReportDimensionValue",
                    "dimensionName": string,
                    "values": [
                      string
                    ],
                    "ids": [
                      string
                    ],
                    "matchType": string
                  }
                }
              ]
            }
          ]
        }
      ]
    },
    "pathFilters": [
      {
        "kind": "dfaReporting#pathFilter",
        "eventFilters": [
          {
            "kind": "dfareporting#eventFilter",
            "dimensionFilter": {
              "kind": "dfareporting#pathReportDimensionValue",
              "dimensionName": string,
              "values": [
                string
              ],
              "ids": [
                string
              ],
              "matchType": string
            }
          }
        ],
        "pathMatchPosition": string
      }
    ],
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ]
  },
  "schedule": {
    "active": boolean,
    "repeats": string,
    "every": integer,
    "repeatsOnWeekDays": [
      string
    ],
    "startDate": date,
    "expirationDate": date,
    "runsOnDayOfMonth": string
  },
  "delivery": {
    "emailOwner": boolean,
    "emailOwnerDeliveryType": string,
    "message": string,
    "recipients": [
      {
        "kind": "dfareporting#recipient",
        "email": string,
        "deliveryType": string
      }
    ]
  }
}
プロパティ名 説明 メモ
accountId long このレポートが属するアカウント ID。
criteria object タイプが STANDARD であるレポートのレポート条件。
criteria.activities nested object アクティビティ グループ。
criteria.activities.filters[] list アクティビティ フィルタの一覧。ディメンション値はすべて「dfa:activity」または「dfa:activityGroup」のいずれかのタイプであることが必要です。 書き込み可能
criteria.activities.kind string リソースの種類。この場合は dfareporting#activities です。
criteria.activities.metricNames[] list Floodlight アクティビティの指標の名前のリスト。 書き込み可能
criteria.customRichMediaEvents nested object カスタム リッチメディア イベント グループ。
criteria.customRichMediaEvents.filteredEventIds[] list カスタム リッチメディアのイベント ID の一覧。ディメンション値はすべてタイプ dfa:richMediaEventTypeIdAndName である必要があります。 書き込み可能
criteria.customRichMediaEvents.kind string リソースの種類。この場合は dfareporting#customRichMediaEvents です。
criteria.dateRange nested object このレポートの実行期間。
criteria.dateRange.endDate date 期間の終了日(その日付を含む)。「yyyy-MM-dd」形式の文字列です。 書き込み可能
criteria.dateRange.kind string リソースの種類。この場合は dfareporting#dateRange です。
criteria.dateRange.relativeDateRange string レポートの実行日を基準とする期間。

設定可能な値は次のとおりです。
  • "LAST_14_DAYS"
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_60_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
書き込み可能
criteria.dateRange.startDate date 期間の開始日(その日付を含む)。「yyyy-MM-dd」形式の文字列です。 書き込み可能
criteria.dimensionFilters[] list ディメンションのフィルタのリスト。

異なるディメンションに対するフィルタは AND で結合され、同じディメンションに対するフィルタはグループ化されて OR で結合されます。

書き込み可能
criteria.dimensions[] list レポートに含める必要がある標準ディメンションのリスト。 書き込み可能
criteria.dimensions[].kind string リソースの種類。この場合は dfareporting#sortedDimension です。
criteria.dimensions[].name string ディメンションの名前。
criteria.dimensions[].sortOrder string ディメンション列の並べ替え順序(省略可)。

設定可能な値は次のとおりです。
  • "ASCENDING"
  • "DESCENDING"
criteria.metricNames[] list レポートに含める必要がある指標の名前のリスト。 書き込み可能
crossDimensionReachCriteria object タイプが CROSS_DIMENSION_REACH であるレポートのレポート条件。 書き込み可能
crossDimensionReachCriteria.breakdown[] list レポートに含める必要があるディメンションのリスト。 書き込み可能
crossDimensionReachCriteria.breakdown[].kind string リソースの種類。この場合は dfareporting#sortedDimension です。
crossDimensionReachCriteria.breakdown[].name string ディメンションの名前。
crossDimensionReachCriteria.breakdown[].sortOrder string ディメンション列の並べ替え順序(省略可)。

設定可能な値は次のとおりです。
  • "ASCENDING"
  • "DESCENDING"
crossDimensionReachCriteria.dateRange nested object このレポートの実行期間。 書き込み可能
crossDimensionReachCriteria.dateRange.endDate date 期間の終了日(その日付を含む)。「yyyy-MM-dd」形式の文字列です。 書き込み可能
crossDimensionReachCriteria.dateRange.kind string リソースの種類。この場合は dfareporting#dateRange です。
crossDimensionReachCriteria.dateRange.relativeDateRange string レポートの実行日を基準とする期間。

設定可能な値は次のとおりです。
  • "LAST_14_DAYS"
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_60_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
書き込み可能
crossDimensionReachCriteria.dateRange.startDate date 期間の開始日(その日付を含む)。「yyyy-MM-dd」形式の文字列です。 書き込み可能
crossDimensionReachCriteria.dimension string ディメンション オプション。

設定可能な値は次のとおりです。
  • "ADVERTISER"
  • "CAMPAIGN"
  • "SITE_BY_ADVERTISER"
  • "SITE_BY_CAMPAIGN"
書き込み可能
crossDimensionReachCriteria.dimensionFilters[] list ディメンションのフィルタのリスト。 書き込み可能
crossDimensionReachCriteria.metricNames[] list レポートに含める必要がある指標の名前のリスト。 書き込み可能
crossDimensionReachCriteria.overlapMetricNames[] list レポートに含める必要がある重複指標の名前のリスト。 書き込み可能
crossDimensionReachCriteria.pivoted boolean レポートがピボット レポートかどうか。デフォルトは true です。 書き込み可能
delivery object レポートのメール配信設定。 書き込み可能
delivery.emailOwner boolean レポートをメールでレポート所有者に送信するかどうか。 書き込み可能
delivery.emailOwnerDeliveryType string 所有者が受信する配信のタイプ(有効になっている場合)。

設定可能な値は次のとおりです。
  • "ATTACHMENT"
  • "LINK"
書き込み可能
delivery.message string 各メールで送信するメッセージ。 書き込み可能
delivery.recipients[] list メールによるレポートの送信先リスト。 書き込み可能
delivery.recipients[].deliveryType string 送信先の配信タイプ。

設定可能な値は次のとおりです。
  • "ATTACHMENT"
  • "LINK"
書き込み可能
delivery.recipients[].email string 送信先のメールアドレス。 書き込み可能
delivery.recipients[].kind string リソースの種類。この場合は dfareporting#recipient です。
etag etag キャッシュ保存用のこのレスポンスの ETag。
fileName string このレポートのレポート ファイルを生成する際に使用されるファイル名。 書き込み可能
floodlightCriteria object タイプが FLOODLIGHT であるレポートのレポート条件。
floodlightCriteria.customRichMediaEvents[] list 含めるカスタム リッチメディア イベントの一覧。
floodlightCriteria.dateRange nested object このレポートの実行期間。
floodlightCriteria.dateRange.endDate date 期間の終了日(その日付を含む)。「yyyy-MM-dd」形式の文字列です。 書き込み可能
floodlightCriteria.dateRange.kind string リソースの種類。この場合は dfareporting#dateRange です。
floodlightCriteria.dateRange.relativeDateRange string レポートの実行日を基準とする期間。

設定可能な値は次のとおりです。
  • "LAST_14_DAYS"
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_60_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
書き込み可能
floodlightCriteria.dateRange.startDate date 期間の開始日(その日付を含む)。「yyyy-MM-dd」形式の文字列です。 書き込み可能
floodlightCriteria.dimensionFilters[] list ディメンションのフィルタのリスト。

異なるディメンションに対するフィルタは AND で結合され、同じディメンションに対するフィルタはグループ化されて OR で結合されます。

書き込み可能
floodlightCriteria.dimensions[] list レポートに含める必要があるディメンションのリスト。 書き込み可能
floodlightCriteria.dimensions[].kind string リソースの種類。この場合は dfareporting#sortedDimension です。
floodlightCriteria.dimensions[].name string ディメンションの名前。
floodlightCriteria.dimensions[].sortOrder string ディメンション列の並べ替え順序(省略可)。

設定可能な値は次のとおりです。
  • "ASCENDING"
  • "DESCENDING"
floodlightCriteria.floodlightConfigId nested object このレポートにデータを含める Floodlight ID。この ID に関連付けられているすべての広告主が自動的に追加されます。値のディメンションは dfa:floodlightConfigId にする必要があります。 書き込み可能
floodlightCriteria.metricNames[] list レポートに含める必要がある指標の名前のリスト。 書き込み可能
floodlightCriteria.reportProperties object レポートのプロパティ。
floodlightCriteria.reportProperties.includeAttributedIPConversions boolean Cookie はないが露出経路はあるコンバージョンを含めるかどうか。
floodlightCriteria.reportProperties.includeUnattributedCookieConversions boolean DoubleClick の Cookie はあるが露出はないユーザーのコンバージョンを含めるかどうか。これは、Floodlight グループ内の広告主の広告をユーザーが閲覧またはクリックしなかったか、ルックバック ウィンドウ外でインタラクションがあったことを意味します。
floodlightCriteria.reportProperties.includeUnattributedIPConversions boolean 関連付けられた Cookie も露出もないコンバージョンを含めるかどうか。この場合、コンバージョン前のルックバック ウィンドウ中にユーザーへの広告の露出があったかどうかはわかりません。
format string レポートの出力形式。指定しなかった場合のデフォルトの形式は CSV です。完了したレポート ファイルの実際の形式は変わることがあります(たとえば、レポートのサイズが形式の容量を超える場合など)。その場合、CSV が代替形式になります。

設定可能な値は次のとおりです。
  • "CSV"
  • "EXCEL"
書き込み可能
id long このレポート リソースを識別する一意の ID。
kind string リソースの種類。この場合は dfareporting#report です。
lastModifiedTime unsigned long このレポートの最終変更のタイムスタンプ(エポックからのミリ秒)。
name string レポートの名前。 書き込み可能
ownerProfileId long このレポートの所有者のユーザー プロフィール ID。
pathAttributionCriteria object タイプが PATH_ATTRIBUTION であるレポートのレポート条件。
pathAttributionCriteria.activityFilters[] list フィルタの対象となる dfa:activity 値のリスト。 書き込み可能
pathAttributionCriteria.customChannelGrouping nested object チャネル グループ。
pathAttributionCriteria.customChannelGrouping.fallbackName string チャネル グループの代替名。
pathAttributionCriteria.customChannelGrouping.kind string リソースの種類。この場合は dfareporting#channelGrouping です。
pathAttributionCriteria.customChannelGrouping.name string チャネル グループ名。
pathAttributionCriteria.customChannelGrouping.rules[] list このチャネル グループに含まれるルール。
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[] list このルールに含まれる選言一致ステートメント。
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[] list この選言一致ステートメントに含まれるイベント フィルタ。
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter nested object この EventFilter に含まれるディメンション フィルタ。
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.dimensionName string ディメンションの名前。
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.ids[] list 値に関連付けられている ID の候補(使用できる場合)。
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.kind string リソースの種類。この場合は dfareporting#pathReportDimensionValue です。
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.matchType string フィルタ適用時の value フィールドの照合方法を指定します。指定しなかった場合は、EXACT になります。WILDCARD_EXPRESSION に設定すると、可変長文字シーケンスのプレースホルダとして「*」を使用できます。この文字はバックスラッシュでエスケープできます。EXACT 以外の matchType を使用できるのは、有料検索のディメンション(dfa:paidSearch*)のみです。

設定可能な値は次のとおりです。
  • "BEGINS_WITH"
  • "CONTAINS"
  • "EXACT"
  • "WILDCARD_EXPRESSION"
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.values[] list ディメンションの候補値。
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].kind string リソースの種類。この場合は dfareporting#eventFilter です。
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].kind string リソースの種類。この場合は dfareporting#disjunctiveMatchStatement です。
pathAttributionCriteria.customChannelGrouping.rules[].kind string リソースの種類。この場合は dfareporting#channelGroupingRule です。
pathAttributionCriteria.customChannelGrouping.rules[].name string ルール名。
pathAttributionCriteria.dateRange nested object このレポートの実行期間。
pathAttributionCriteria.dateRange.endDate date 期間の終了日(その日付を含む)。「yyyy-MM-dd」形式の文字列です。 書き込み可能
pathAttributionCriteria.dateRange.kind string リソースの種類。この場合は dfareporting#dateRange です。
pathAttributionCriteria.dateRange.relativeDateRange string レポートの実行日を基準とする期間。

設定可能な値は次のとおりです。
  • "LAST_14_DAYS"
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_60_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
書き込み可能
pathAttributionCriteria.dateRange.startDate date 期間の開始日(その日付を含む)。「yyyy-MM-dd」形式の文字列です。 書き込み可能
pathAttributionCriteria.dimensions[] list レポートに含める必要があるディメンションのリスト。 書き込み可能
pathAttributionCriteria.dimensions[].kind string リソースの種類。この場合は dfareporting#sortedDimension です。
pathAttributionCriteria.dimensions[].name string ディメンションの名前。
pathAttributionCriteria.dimensions[].sortOrder string ディメンション列の並べ替え順序(省略可)。

設定可能な値は次のとおりです。
  • "ASCENDING"
  • "DESCENDING"
pathAttributionCriteria.floodlightConfigId nested object このレポートにデータを含める Floodlight ID。この ID に関連付けられているすべての広告主が自動的に追加されます。値のディメンションは dfa:floodlightConfigId にする必要があります。 書き込み可能
pathAttributionCriteria.metricNames[] list レポートに含める必要がある指標の名前のリスト。 書き込み可能
pathAttributionCriteria.pathFilters[] list 経路フィルタ。
pathAttributionCriteria.pathFilters[].eventFilters[] list 経路レポートに含まれるイベント フィルタ。
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter nested object この EventFilter に含まれるディメンション フィルタ。
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter.dimensionName string ディメンションの名前。
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter.ids[] list 値に関連付けられている ID の候補(使用できる場合)。
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter.kind string リソースの種類。この場合は dfareporting#pathReportDimensionValue です。
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter.matchType string フィルタ適用時の value フィールドの照合方法を指定します。指定しなかった場合は、EXACT になります。WILDCARD_EXPRESSION に設定すると、可変長文字シーケンスのプレースホルダとして「*」を使用できます。この文字はバックスラッシュでエスケープできます。EXACT 以外の matchType を使用できるのは、有料検索のディメンション(dfa:paidSearch*)のみです。

設定可能な値は次のとおりです。
  • "BEGINS_WITH"
  • "CONTAINS"
  • "EXACT"
  • "WILDCARD_EXPRESSION"
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter.values[] list ディメンションの候補値。
pathAttributionCriteria.pathFilters[].eventFilters[].kind string リソースの種類。この場合は dfareporting#eventFilter です。
pathAttributionCriteria.pathFilters[].kind string リソースの種類。この場合は dfareporting#pathFilter です。
pathAttributionCriteria.pathFilters[].pathMatchPosition string フィルタ適用時の value フィールドの照合方法を指定します。指定しなかった場合は、EXACT になります。WILDCARD_EXPRESSION に設定すると、可変長文字シーケンスのプレースホルダとして「*」を使用できます。この文字はバックスラッシュでエスケープできます。EXACT 以外の matchType を使用できるのは、有料検索のディメンション(dfa:paidSearch*)のみです。

設定可能な値は次のとおりです。
  • "ANY"
  • "FIRST"
  • "LAST"
  • "PATH_MATCH_POSITION_UNSPECIFIED"
pathCriteria object タイプが PATH であるレポートのレポート条件。
pathCriteria.activityFilters[] list フィルタの対象となる dfa:activity 値のリスト。 書き込み可能
pathCriteria.customChannelGrouping nested object チャネル グループ。
pathCriteria.customChannelGrouping.fallbackName string チャネル グループの代替名。
pathCriteria.customChannelGrouping.kind string リソースの種類。この場合は dfareporting#channelGrouping です。
pathCriteria.customChannelGrouping.name string チャネル グループ名。
pathCriteria.customChannelGrouping.rules[] list このチャネル グループに含まれるルール。
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[] list このルールに含まれる選言一致ステートメント。
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[] list この選言一致ステートメントに含まれるイベント フィルタ。
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter nested object この EventFilter に含まれるディメンション フィルタ。
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.dimensionName string ディメンションの名前。
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.ids[] list 値に関連付けられている ID の候補(使用できる場合)。
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.kind string リソースの種類。この場合は dfareporting#pathReportDimensionValue です。
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.matchType string フィルタ適用時の value フィールドの照合方法を指定します。指定しなかった場合は、EXACT になります。WILDCARD_EXPRESSION に設定すると、可変長文字シーケンスのプレースホルダとして「*」を使用できます。この文字はバックスラッシュでエスケープできます。EXACT 以外の matchType を使用できるのは、有料検索のディメンション(dfa:paidSearch*)のみです。

設定可能な値は次のとおりです。
  • "BEGINS_WITH"
  • "CONTAINS"
  • "EXACT"
  • "WILDCARD_EXPRESSION"
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.values[] list ディメンションの候補値。
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].kind string リソースの種類。この場合は dfareporting#eventFilter です。
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].kind string リソースの種類。この場合は dfareporting#disjunctiveMatchStatement です。
pathCriteria.customChannelGrouping.rules[].kind string リソースの種類。この場合は dfareporting#channelGroupingRule です。
pathCriteria.customChannelGrouping.rules[].name string ルール名。
pathCriteria.dateRange nested object このレポートの実行期間。
pathCriteria.dateRange.endDate date 期間の終了日(その日付を含む)。「yyyy-MM-dd」形式の文字列です。 書き込み可能
pathCriteria.dateRange.kind string リソースの種類。この場合は dfareporting#dateRange です。
pathCriteria.dateRange.relativeDateRange string レポートの実行日を基準とする期間。

設定可能な値は次のとおりです。
  • "LAST_14_DAYS"
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_60_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
書き込み可能
pathCriteria.dateRange.startDate date 期間の開始日(その日付を含む)。「yyyy-MM-dd」形式の文字列です。 書き込み可能
pathCriteria.dimensions[] list レポートに含める必要があるディメンションのリスト。 書き込み可能
pathCriteria.dimensions[].kind string リソースの種類。この場合は dfareporting#sortedDimension です。
pathCriteria.dimensions[].name string ディメンションの名前。
pathCriteria.dimensions[].sortOrder string ディメンション列の並べ替え順序(省略可)。

設定可能な値は次のとおりです。
  • "ASCENDING"
  • "DESCENDING"
pathCriteria.floodlightConfigId nested object このレポートにデータを含める Floodlight ID。この ID に関連付けられているすべての広告主が自動的に追加されます。値のディメンションは dfa:floodlightConfigId にする必要があります。 書き込み可能
pathCriteria.metricNames[] list レポートに含める必要がある指標の名前のリスト。 書き込み可能
pathCriteria.pathFilters[] list 経路フィルタ。
pathCriteria.pathFilters[].eventFilters[] list 経路レポートに含まれるイベント フィルタ。
pathCriteria.pathFilters[].eventFilters[].dimensionFilter nested object この EventFilter に含まれるディメンション フィルタ。
pathCriteria.pathFilters[].eventFilters[].dimensionFilter.dimensionName string ディメンションの名前。
pathCriteria.pathFilters[].eventFilters[].dimensionFilter.ids[] list 値に関連付けられている ID の候補(使用できる場合)。
pathCriteria.pathFilters[].eventFilters[].dimensionFilter.kind string リソースの種類。この場合は dfareporting#pathReportDimensionValue です。
pathCriteria.pathFilters[].eventFilters[].dimensionFilter.matchType string フィルタ適用時の value フィールドの照合方法を指定します。指定しなかった場合は、EXACT になります。WILDCARD_EXPRESSION に設定すると、可変長文字シーケンスのプレースホルダとして「*」を使用できます。この文字はバックスラッシュでエスケープできます。EXACT 以外の matchType を使用できるのは、有料検索のディメンション(dfa:paidSearch*)のみです。

設定可能な値は次のとおりです。
  • "BEGINS_WITH"
  • "CONTAINS"
  • "EXACT"
  • "WILDCARD_EXPRESSION"
pathCriteria.pathFilters[].eventFilters[].dimensionFilter.values[] list ディメンションの候補値。
pathCriteria.pathFilters[].eventFilters[].kind string リソースの種類。この場合は dfareporting#eventFilter です。
pathCriteria.pathFilters[].kind string リソースの種類。この場合は dfareporting#pathFilter です。
pathCriteria.pathFilters[].pathMatchPosition string フィルタ適用時の value フィールドの照合方法を指定します。指定しなかった場合は、EXACT になります。WILDCARD_EXPRESSION に設定すると、可変長文字シーケンスのプレースホルダとして「*」を使用できます。この文字はバックスラッシュでエスケープできます。EXACT 以外の matchType を使用できるのは、有料検索のディメンション(dfa:paidSearch*)のみです。

設定可能な値は次のとおりです。
  • "ANY"
  • "FIRST"
  • "LAST"
  • "PATH_MATCH_POSITION_UNSPECIFIED"
pathToConversionCriteria object タイプが PATH_TO_CONVERSION であるレポートのレポート条件。
pathToConversionCriteria.activityFilters[] list フィルタの対象となる dfa:activity 値のリスト。 書き込み可能
pathToConversionCriteria.conversionDimensions[] list レポートに含める必要があるコンバージョン ディメンションのリスト。 書き込み可能
pathToConversionCriteria.conversionDimensions[].kind string リソースの種類。この場合は dfareporting#sortedDimension です。
pathToConversionCriteria.conversionDimensions[].name string ディメンションの名前。
pathToConversionCriteria.conversionDimensions[].sortOrder string ディメンション列の並べ替え順序(省略可)。

設定可能な値は次のとおりです。
  • "ASCENDING"
  • "DESCENDING"
pathToConversionCriteria.customFloodlightVariables[] list レポートに含める必要があるカスタム Floodlight 変数のリスト。 書き込み可能
pathToConversionCriteria.customFloodlightVariables[].kind string リソースの種類。この場合は dfareporting#sortedDimension です。
pathToConversionCriteria.customFloodlightVariables[].name string ディメンションの名前。
pathToConversionCriteria.customFloodlightVariables[].sortOrder string ディメンション列の並べ替え順序(省略可)。

設定可能な値は次のとおりです。
  • "ASCENDING"
  • "DESCENDING"
pathToConversionCriteria.customRichMediaEvents[] list 含めるカスタム リッチメディア イベントのリスト。
pathToConversionCriteria.dateRange nested object このレポートの実行期間。
pathToConversionCriteria.dateRange.endDate date 期間の終了日(その日付を含む)。「yyyy-MM-dd」形式の文字列です。 書き込み可能
pathToConversionCriteria.dateRange.kind string リソースの種類。この場合は dfareporting#dateRange です。
pathToConversionCriteria.dateRange.relativeDateRange string レポートの実行日を基準とする期間。

設定可能な値は次のとおりです。
  • "LAST_14_DAYS"
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_60_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
書き込み可能
pathToConversionCriteria.dateRange.startDate date 期間の開始日(その日付を含む)。「yyyy-MM-dd」形式の文字列です。 書き込み可能
pathToConversionCriteria.floodlightConfigId nested object このレポートにデータを含める Floodlight ID。この ID に関連付けられているすべての広告主が自動的に追加されます。値のディメンションは dfa:floodlightConfigId にする必要があります。 書き込み可能
pathToConversionCriteria.metricNames[] list レポートに含める必要がある指標の名前のリスト。 書き込み可能
pathToConversionCriteria.perInteractionDimensions[] list レポートに含める必要がある接点ごとのディメンションのリスト。 書き込み可能
pathToConversionCriteria.perInteractionDimensions[].kind string リソースの種類。この場合は dfareporting#sortedDimension です。
pathToConversionCriteria.perInteractionDimensions[].name string ディメンションの名前。
pathToConversionCriteria.perInteractionDimensions[].sortOrder string ディメンション列の並べ替え順序(省略可)。

設定可能な値は次のとおりです。
  • "ASCENDING"
  • "DESCENDING"
pathToConversionCriteria.reportProperties object レポートのプロパティ。
pathToConversionCriteria.reportProperties.clicksLookbackWindow integer コンバージョンが発生する前に、クリックのインタラクションが発生していたかどうかをチェックする期間を指定します。デフォルトでは、Floodlight の値が使用されます。また、手動でカスタム値を入力することもできます。有効な値は 1~90 です。
pathToConversionCriteria.reportProperties.impressionsLookbackWindow integer コンバージョンが発生する前に、インプレッションのインタラクションが発生していたかどうかをチェックする期間を指定します。デフォルトでは、Floodlight の値が使用されます。また、手動でカスタム値を入力することもできます。有効な値は 1~90 です。
pathToConversionCriteria.reportProperties.includeAttributedIPConversions boolean サポート終了: 使用しても効果はありません。
pathToConversionCriteria.reportProperties.includeUnattributedCookieConversions boolean DoubleClick の Cookie はあるが露出はないユーザーのコンバージョンを含めるかどうか。これは、Floodlight グループ内の広告主の広告をユーザーが閲覧またはクリックしなかったか、ルックバック ウィンドウ外でインタラクションがあったことを意味します。
pathToConversionCriteria.reportProperties.includeUnattributedIPConversions boolean 関連付けられた Cookie も露出もないコンバージョンを含めるかどうか。この場合、コンバージョン前のルックバック ウィンドウ中にユーザーへの広告の露出があったかどうかはわかりません。
pathToConversionCriteria.reportProperties.maximumClickInteractions integer レポートに含める最大クリック インタラクション数。現在、E2C レポートの利用料を支払っている広告主は、最大 200 回(クリック 100 回、インプレッション 100 回)まで取得できます。ネットワーク内の別の広告主が E2C の利用料を支払っている場合は、レポートごとに最大合計 5 回まで表示できます。
pathToConversionCriteria.reportProperties.maximumImpressionInteractions integer レポートに含める最大クリック インタラクション数。現在、E2C レポートの利用料を支払っている広告主は、最大 200 回(クリック 100 回、インプレッション 100 回)まで取得できます。ネットワーク内の別の広告主が E2C の利用料を支払っている場合は、レポートごとに最大合計 5 回まで表示できます。
pathToConversionCriteria.reportProperties.maximumInteractionGap integer 同じユーザーによるインタラクション(クリックまたはインプレッション)間の最大間隔。有効な値は 1~90 です。
pathToConversionCriteria.reportProperties.pivotOnInteractionPath boolean インタラクション経路でのピボットを有効にします。
reachCriteria object タイプが REACH であるレポートのレポート条件。
reachCriteria.activities nested object アクティビティ グループ。
reachCriteria.activities.filters[] list アクティビティ フィルタの一覧。ディメンション値はすべて「dfa:activity」または「dfa:activityGroup」のいずれかのタイプであることが必要です。 書き込み可能
reachCriteria.activities.kind string リソースの種類。この場合は dfareporting#activities です。
reachCriteria.activities.metricNames[] list Floodlight アクティビティの指標の名前のリスト。 書き込み可能
reachCriteria.customRichMediaEvents nested object カスタム リッチメディア イベント グループ。
reachCriteria.customRichMediaEvents.filteredEventIds[] list カスタム リッチメディアのイベント ID の一覧。ディメンション値はすべてタイプ dfa:richMediaEventTypeIdAndName である必要があります。 書き込み可能
reachCriteria.customRichMediaEvents.kind string リソースの種類。この場合は dfareporting#customRichMediaEvents です。
reachCriteria.dateRange nested object このレポートの実行期間。
reachCriteria.dateRange.endDate date 期間の終了日(その日付を含む)。「yyyy-MM-dd」形式の文字列です。 書き込み可能
reachCriteria.dateRange.kind string リソースの種類。この場合は dfareporting#dateRange です。
reachCriteria.dateRange.relativeDateRange string レポートの実行日を基準とする期間。

設定可能な値は次のとおりです。
  • "LAST_14_DAYS"
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_60_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
書き込み可能
reachCriteria.dateRange.startDate date 期間の開始日(その日付を含む)。「yyyy-MM-dd」形式の文字列です。 書き込み可能
reachCriteria.dimensionFilters[] list ディメンションのフィルタのリスト。

異なるディメンションに対するフィルタは AND で結合され、同じディメンションに対するフィルタはグループ化されて OR で結合されます。

書き込み可能
reachCriteria.dimensions[] list レポートに含める必要があるディメンションのリスト。 書き込み可能
reachCriteria.dimensions[].kind string リソースの種類。この場合は dfareporting#sortedDimension です。
reachCriteria.dimensions[].name string ディメンションの名前。
reachCriteria.dimensions[].sortOrder string ディメンション列の並べ替え順序(省略可)。

設定可能な値は次のとおりです。
  • "ASCENDING"
  • "DESCENDING"
reachCriteria.enableAllDimensionCombinations boolean レポートですべてのリーチ ディメンションの組み合わせを有効にするかどうか。デフォルトは false です。有効にした場合、レポートの期間が過去 42 日以内であることが必要です。 書き込み可能
reachCriteria.metricNames[] list レポートに含める必要がある指標の名前のリスト。 書き込み可能
reachCriteria.reachByFrequencyMetricNames[] list レポートに含める必要があるフリークエンシー別リーチ指標の名前のリスト。 書き込み可能
schedule object レポートのスケジュール。このプロパティを設定できるのは、レポートの「dateRange」が相対的な期間で、その相対的な期間が「TODAY」以外の場合のみです。 書き込み可能
schedule.active boolean スケジュールがアクティブかどうか。true または false のどちらかに設定する必要があります。 書き込み可能
schedule.every integer レポートを実行する間隔(日数、週数、または月数)を定義します。repeats が "DAILY"、"WEEKLY"、"MONTHLY" のいずれかである場合に設定する必要があります。 書き込み可能
schedule.expirationDate date スケジュール設定されたレポートが実行を停止する有効期限。 書き込み可能
schedule.repeats string レポートの実行間隔。注:
  • "DAILY" の場合、フィールド every も設定する必要があります。
  • "WEEKLY" の場合、フィールド every とフィールド repeatsOnWeekDays も設定する必要があります。
  • "MONTHLY" の場合、フィールド every とフィールド runsOnDayOfMonth も設定する必要があります。
書き込み可能
schedule.repeatsOnWeekDays[] list 「WEEKLY」スケジュールを設定したレポートを実行する曜日の一覧。 書き込み可能
schedule.runsOnDayOfMonth string 「MONTHLY」スケジュールを設定したレポートを毎月「startDate」と同じ日に繰り返すか、または毎月同じ週の同じ曜日に繰り返すかを定義する列挙値。

たとえば、「startDate」が 2012 年 4 月 2 日(2012-04-02)月曜日である場合、それ以降のレポートは「DAY_OF_MONTH」を指定すると毎月 2 日に実行され、「WEEK_OF_MONTH」を指定すると毎月第 1 月曜日に実行されます。



設定可能な値は次のとおりです。
  • "DAY_OF_MONTH"
  • "WEEK_OF_MONTH"
書き込み可能
schedule.startDate date スケジュール設定されたレポートを実行する期間の開始日。 書き込み可能
subAccountId long このレポートが属するサブアカウント ID(該当する場合)。
type string レポートのタイプ。

設定可能な値は次のとおりです。
  • "CROSS_DIMENSION_REACH"
  • "FLOODLIGHT"
  • "PATH"
  • "PATH_ATTRIBUTION"
  • "PATH_TO_CONVERSION"
  • "REACH"
  • "STANDARD"

メソッド

レポートを操作するためのメソッドの一覧です。

delete
ID により、レポートを削除します。
get
ID により、レポートを取得します。
insert
レポートを作成します。
list
レポートのリストを取得します。
patch
レポートを更新します。このメソッドはパッチのセマンティクスをサポートしています。
run
レポートを実行します。
update
レポートを更新します。