Display & Video 360 API . floodlightGroups . floodlightActivities

close()

Close httplib2 connections.

get(floodlightGroupId, floodlightActivityId, partnerId=None, x__xgafv=None)

Gets a Floodlight activity.

Args:
  floodlightGroupId: string, Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs. (required)
  floodlightActivityId: string, Required. The ID of the Floodlight activity to fetch. (required)
  partnerId: string, Required. The ID of the partner through which the Floodlight activity is being accessed.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A single Floodlight activity.
  "advertiserIds": [ # Output only. IDs of the advertisers that have access to the parent Floodlight group. Only advertisers under the provided partner ID will be listed in this field.
    "A String",
  ],
  "displayName": "A String", # Required. The display name of the Floodlight activity.
  "floodlightActivityId": "A String", # Output only. The unique ID of the Floodlight activity. Assigned by the system.
  "floodlightGroupId": "A String", # Required. Immutable. The ID of the parent Floodlight group.
  "name": "A String", # Output only. The resource name of the Floodlight activity.
  "remarketingConfigs": [ # Output only. A list of configuration objects designating whether remarketing for this Floodlight Activity is enabled and available for a specifc advertiser. If enabled, this Floodlight Activity generates a remarketing user list that is able to be used in targeting under the advertiser.
    { # Settings that control the whether remarketing is enabled for the given identified advertiser.
      "advertiserId": "A String", # Output only. The ID of the advertiser.
      "remarketingEnabled": True or False, # Output only. Whether the Floodlight activity remarketing user list is available to the identified advertiser.
    },
  ],
  "servingStatus": "A String", # Optional. Whether the Floodlight activity is served.
  "sslRequired": True or False, # Output only. Whether tags are required to be compliant.
}

list(floodlightGroupId, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

Lists Floodlight activities in a Floodlight group.

Args:
  floodlightGroupId: string, Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong. (required)
  orderBy: string, Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `floodlightActivityId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
  pageSize: integer, Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
  pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFloodlightActivities` method. If not specified, the first page of results will be returned.
  partnerId: string, Required. The ID of the partner through which the Floodlight activities are being accessed.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "floodlightActivities": [ # The list of Floodlight activities. This list will be absent if empty.
    { # A single Floodlight activity.
      "advertiserIds": [ # Output only. IDs of the advertisers that have access to the parent Floodlight group. Only advertisers under the provided partner ID will be listed in this field.
        "A String",
      ],
      "displayName": "A String", # Required. The display name of the Floodlight activity.
      "floodlightActivityId": "A String", # Output only. The unique ID of the Floodlight activity. Assigned by the system.
      "floodlightGroupId": "A String", # Required. Immutable. The ID of the parent Floodlight group.
      "name": "A String", # Output only. The resource name of the Floodlight activity.
      "remarketingConfigs": [ # Output only. A list of configuration objects designating whether remarketing for this Floodlight Activity is enabled and available for a specifc advertiser. If enabled, this Floodlight Activity generates a remarketing user list that is able to be used in targeting under the advertiser.
        { # Settings that control the whether remarketing is enabled for the given identified advertiser.
          "advertiserId": "A String", # Output only. The ID of the advertiser.
          "remarketingEnabled": True or False, # Output only. Whether the Floodlight activity remarketing user list is available to the identified advertiser.
        },
      ],
      "servingStatus": "A String", # Optional. Whether the Floodlight activity is served.
      "sslRequired": True or False, # Output only. Whether tags are required to be compliant.
    },
  ],
  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListFloodlightActivities` method to retrieve the next page of results.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.