AdMob API . accounts . campaigns

Instance Methods

batchUpdate(parent, body=None, x__xgafv=None)

Batch update operation for campaigns under the specified AdMob publisher.

close()

Close httplib2 connections.

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

List the campaigns under the specified AdMob account.

list_next()

Retrieves the next page of results.

Method Details

batchUpdate(parent, body=None, x__xgafv=None)
Batch update operation for campaigns under the specified AdMob publisher.

Args:
  parent: string, Required. Resource name of the account to list campaigns for. The `parent` field in the individual UpdateCampaignRequest messages should match the value set here. Example: accounts/pub-9876543210987654 (required)
  body: object, The request body.
    The object takes the form of:

{ # The request for the BatchUpdateCampaigns API.
  "requests": [ # Required. The individual requests to update campaigns. Max 1000 allowed.
    { # An update request for a singular campaign. Currently only cpi_micros of MAX_CPI and TARGET_CPI campaigns can be updated.
      "campaign": { # Describes an AdMob campaign. # Required. The campaign which is being updated.
        "cpiSetting": { # CPI setting for AdMob campaign. Ignored unless campaign goal type is MAX_CPI or TARGET_CPI. # The CPI setting of the campaign.
          "cpiMicros": "A String", # Cost-per-install for this campaign in micro units in the currency of the GoogleAds account linked to this AdMob publisher.
        },
        "displayName": "A String", # Output only. The display name for the campaign.
        "goalType": "A String", # Output only. The Goal type of the campaign.
        "name": "A String", # Output only. Resource name for this campaign. Format is: accounts/{publisher_id}/campaigns/{campaign_id} Example: accounts/pub-9876543210987654/campaigns/0123456789
      },
      "updateMask": "A String", # List of campaign fields to be updated. Currently this field is not supported as only the cpi_micros field can be updated.
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for the BatchUpdateCampaigns API.
  "campaigns": [ # The updated campaigns per the request.
    { # Describes an AdMob campaign.
      "cpiSetting": { # CPI setting for AdMob campaign. Ignored unless campaign goal type is MAX_CPI or TARGET_CPI. # The CPI setting of the campaign.
        "cpiMicros": "A String", # Cost-per-install for this campaign in micro units in the currency of the GoogleAds account linked to this AdMob publisher.
      },
      "displayName": "A String", # Output only. The display name for the campaign.
      "goalType": "A String", # Output only. The Goal type of the campaign.
      "name": "A String", # Output only. Resource name for this campaign. Format is: accounts/{publisher_id}/campaigns/{campaign_id} Example: accounts/pub-9876543210987654/campaigns/0123456789
    },
  ],
}
close()
Close httplib2 connections.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
List the campaigns under the specified AdMob account.

Args:
  parent: string, Required. Resource name of the account to list campaigns for. Example: accounts/pub-9876543210987654 (required)
  filter: string, The filter string that uses [EBNF grammar syntax](https://google.aip.dev/assets/misc/ebnf-filtering.txt). Possible field to filter by is: - "CAMPAIGN_GOAL_TYPE" Possible filter function is: - `IN`: Used to filter fields that represent a singleton including "CAMPAIGN_GOAL_TYPE". The filter functions can be added together using `AND`. `OR` functionality is not supported. Example: filter: IN(CAMPAIGN_GOAL_TYPE, "NUMBER_OF_CLICKS", "MEDIATED_ADS")
  pageSize: integer, The maximum number of campaigns to return.
  pageToken: string, The value returned by the last `ListCampaignsResponse`; indicates that this is a continuation of a prior `ListGoogleBiddingAdUnits` call, and that the system should return the next page of data.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for the ListCampaignsRequest.
  "campaigns": [ # The resulting mediation groups for the requested account.
    { # Describes an AdMob campaign.
      "cpiSetting": { # CPI setting for AdMob campaign. Ignored unless campaign goal type is MAX_CPI or TARGET_CPI. # The CPI setting of the campaign.
        "cpiMicros": "A String", # Cost-per-install for this campaign in micro units in the currency of the GoogleAds account linked to this AdMob publisher.
      },
      "displayName": "A String", # Output only. The display name for the campaign.
      "goalType": "A String", # Output only. The Goal type of the campaign.
      "name": "A String", # Output only. Resource name for this campaign. Format is: accounts/{publisher_id}/campaigns/{campaign_id} Example: accounts/pub-9876543210987654/campaigns/0123456789
    },
  ],
  "nextPageToken": "A String", # Used to set the `page_token` in the `ListCampaignsRequest` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}
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.